Class ForumsService

constructor

• new ForumsService(httpRequest): ForumsService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns ForumsService

Readonly httpRequest

forumTopicCreate

• forumTopicCreate(options): CancelablePromise<{
      forumTopic: ForumTopicPayload;
  }>

• Create a topic in a forum

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        requestBody: {
            content: string | Record<string, any>;
            title: string;
        };
    }

    • channelId: string

    • requestBody: {
          content: string | Record<string, any>;
          title: string;
      }

      • content: string | Record<string, any>

        The content of the forum topic

      • title: string

        The title of the forum topic

  Returns CancelablePromise<{
      forumTopic: ForumTopicPayload;
  }>

  any Success

forumTopicDelete

• forumTopicDelete(options): CancelablePromise<void>

• Delete a forum topic

  Throws

  ApiError

  Parameters

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

    • channelId: string

    • forumTopicId: number

  Returns CancelablePromise<void>

  void

forumTopicLock

• forumTopicLock(options): CancelablePromise<void>

• Lock a forum topic

  Throws

  ApiError

  Parameters

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

    • channelId: string

    • forumTopicId: number

  Returns CancelablePromise<void>

  void

forumTopicPin

• forumTopicPin(options): CancelablePromise<void>

• Pin a forum topic

  Throws

  ApiError

  Parameters

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

    • channelId: string

    • forumTopicId: number

  Returns CancelablePromise<void>

  void

forumTopicRead

• forumTopicRead(options): CancelablePromise<{
      forumTopic: ForumTopicPayload;
  }>

• Get a forum topic

  Throws

  ApiError

  Parameters

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

    • channelId: string

    • forumTopicId: number

  Returns CancelablePromise<{
      forumTopic: ForumTopicPayload;
  }>

  any Success

forumTopicReadMany

• forumTopicReadMany(options): CancelablePromise<{
      forumTopics: ForumTopicSummaryPayload[];
  }>

• Get forum topics

  Throws

  ApiError

  Parameters

  • options: {
        before?: string;
        channelId: string;
        limit?: number;
    }

    • Optional before?: string

    • channelId: string

    • Optional limit?: number

  Returns CancelablePromise<{
      forumTopics: ForumTopicSummaryPayload[];
  }>

  any Success

forumTopicUnlock

• forumTopicUnlock(options): CancelablePromise<void>

• Unlock a forum topic

  Throws

  ApiError

  Parameters

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

    • channelId: string

    • forumTopicId: number

  Returns CancelablePromise<void>

  void

forumTopicUnpin

• forumTopicUnpin(options): CancelablePromise<void>

• Unpin a forum topic

  Throws

  ApiError

  Parameters

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

    • channelId: string

    • forumTopicId: number

  Returns CancelablePromise<void>

  void

forumTopicUpdate

• forumTopicUpdate(options): CancelablePromise<{
      forumTopic: ForumTopicPayload;
  }>

• Update a forum topic

  Throws

  ApiError

  Parameters

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

    • channelId: string

    • forumTopicId: number

    • requestBody: {
          content?: string;
          title?: string;
      }

      • Optional content?: string

        The content of the forum topic

      • Optional title?: string

        The title of the forum topic

  Returns CancelablePromise<{
      forumTopic: ForumTopicPayload;
  }>

  any Success