Class ForumCommentsService

constructor

• new ForumCommentsService(httpRequest): ForumCommentsService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns ForumCommentsService

Readonly httpRequest

forumTopicCommentCreate

• forumTopicCommentCreate(options): CancelablePromise<{
      forumTopicComment: ForumTopicCommentPayload;
  }>

• Create a forum topic comment

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        forumTopicId: number;
        requestBody: {
            content: string;
        };
    }

    • channelId: string

    • forumTopicId: number

    • requestBody: {
          content: string;
      }

      • content: string

        The content of the forum topic comment

  Returns CancelablePromise<{
      forumTopicComment: ForumTopicCommentPayload;
  }>

  any Success

forumTopicCommentDelete

• forumTopicCommentDelete(options): CancelablePromise<void>

• Delete a forum topic comment

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        forumTopicCommentId: number;
        forumTopicId: number;
    }

    • channelId: string

    • forumTopicCommentId: number

    • forumTopicId: number

  Returns CancelablePromise<void>

  void

forumTopicCommentRead

• forumTopicCommentRead(options): CancelablePromise<{
      forumTopicComment: ForumTopicCommentPayload;
  }>

• Get a comment on a forum topic

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        forumTopicCommentId: number;
        forumTopicId: number;
    }

    • channelId: string

    • forumTopicCommentId: number

    • forumTopicId: number

  Returns CancelablePromise<{
      forumTopicComment: ForumTopicCommentPayload;
  }>

  any Success

forumTopicCommentReadMany

• forumTopicCommentReadMany(options): CancelablePromise<{
      forumTopicComments: ForumTopicCommentPayload[];
  }>

• Get a forum topic's comments

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        forumTopicId: number;
    }

    • channelId: string

    • forumTopicId: number

  Returns CancelablePromise<{
      forumTopicComments: ForumTopicCommentPayload[];
  }>

  any Success

forumTopicCommentUpdate

• forumTopicCommentUpdate(options): CancelablePromise<{
      forumTopicComment: ForumTopicCommentPayload;
  }>

• Update a forum topic comment

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        forumTopicCommentId: number;
        forumTopicId: number;
        requestBody: {
            content?: string;
        };
    }

    • channelId: string

    • forumTopicCommentId: number

    • forumTopicId: number

    • requestBody: {
          content?: string;
      }

      • Optional content?: string

        The content of the forum topic

  Returns CancelablePromise<{
      forumTopicComment: ForumTopicCommentPayload;
  }>

  any Success