Class ChannelsService

constructor

• new ChannelsService(httpRequest): ChannelsService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns ChannelsService

Readonly httpRequest

channelArchiveCreate

• channelArchiveCreate(options): CancelablePromise<void>

• Archive a channel

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
    }

    • channelId: string

  Returns CancelablePromise<void>

  void

channelArchiveDelete

• channelArchiveDelete(options): CancelablePromise<void>

• Restore an archived channel

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
    }

    • channelId: string

  Returns CancelablePromise<void>

  void

channelCreate

• channelCreate(options): CancelablePromise<{
      channel: ServerChannelPayload;
  }>

• Create a channel Only server channels are supported at this time (coming soon™: DM Channels!). By default, a channel will be created with a null value for priority on a server. You can update its priority using the channel update route

  Throws

  ApiError

  Parameters

  • options: {
        requestBody: {
            categoryId?: number;
            groupId?: string;
            messageId?: string;
            name: string;
            parentId?: string;
            serverId?: string;
            topic?: string;
            type: "announcements" | "chat" | "calendar" | "forums" | "media" | "docs" | "voice" | "list" | "scheduling" | "stream";
            visibility?: null | "private" | "public";
        };
    }

    • requestBody: {
          categoryId?: number;
          groupId?: string;
          messageId?: string;
          name: string;
          parentId?: string;
          serverId?: string;
          topic?: string;
          type: "announcements" | "chat" | "calendar" | "forums" | "media" | "docs" | "voice" | "list" | "scheduling" | "stream";
          visibility?: null | "private" | "public";
      }

      • Optional categoryId?: number

        The category that the channel exists in. Only relevant for server channels. If not provided, channel will be a top-level channel. Optional if providing a parentId or messageId

      • Optional groupId?: string

        The ID of the group. If not provided, channel will be created in the "Server home" group from serverId or in the group that corresponds to the categoryId parameter. Optional if providing a groupId, categoryId, parentId or messageId

      • Optional messageId?: string

        The ID of the message that this channel was created off of. Only applicable to "chat", "voice", and "stream" channels and indicates that this channel is a thread, if present

      • name: string

        The name of the channel

      • Optional parentId?: string

        ID of the immediate parent channel or thread in the channel hierarchy. Only applicable to "chat", "voice", and "stream" channels and indicates that this channel is a thread, if present. Optional if providing a messageId

      • Optional serverId?: string

        The ID of the server. Optional if providing a groupId, categoryId, parentId or messageId

      • Optional topic?: string

        The topic of the channel. Not applicable to threads

      • type: "announcements" | "chat" | "calendar" | "forums" | "media" | "docs" | "voice" | "list" | "scheduling" | "stream"

        The type of channel. This will determine what routes to use for creating content in a channel. For example, if this "chat", then one must use the routes for creating channel messages. For threads, this must be "chat" for now

      • Optional visibility?: null | "private" | "public"

        What users can access the channel. Only applicable to server channels. If not present, this channel will respect normal permissions. public is accessible to everyone, even those who aren't of the server. private is only accessible to explicitly mentioned users. Currently, threads cannot be public and other channels cannot be private. Additionally, private threads can only exist with an associated messageId that is for a private message

  Returns CancelablePromise<{
      channel: ServerChannelPayload;
  }>

  any Success

channelDelete

• channelDelete(options): CancelablePromise<void>

• Delete a channel Only server channels are supported at this time (coming soon™: DM Channels!)

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
    }

    • channelId: string

  Returns CancelablePromise<void>

  void

channelRead

• channelRead(options): CancelablePromise<{
      channel: ServerChannelPayload;
  }>

• Get a channel Must be a member of the server to get the channel. Only server channels are supported at this time (coming soon™: DM Channels!)

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
    }

    • channelId: string

  Returns CancelablePromise<{
      channel: ServerChannelPayload;
  }>

  any Success

channelUpdate

• channelUpdate(options): CancelablePromise<{
      channel: ServerChannelPayload;
  }>

• Update a channel Only server channels are supported at this time (coming soon™: DM Channels!)

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        requestBody: {
            name?: string;
            priority?: number;
            topic?: null | string;
            visibility?: null | "public";
        };
    }

    • channelId: string

    • requestBody: {
          name?: string;
          priority?: number;
          topic?: null | string;
          visibility?: null | "public";
      }

      • Optional name?: string

        The name of the channel or thread

      • Optional priority?: number

        The priority of the channel will determine its position relative to other categories in the group. The higher the value, the higher up it will be displayed in the UI. Returned values can be null, in which case sorting will be done by createdAt in ascending order. Due to legacy issues, sending a null value is not possible

      • Optional topic?: null | string

        The topic of the channel. Not applicable to threads

      • Optional visibility?: null | "public"

        What users can access the channel. Only applicable to server channels. If not present, this channel will respect normal permissions. public is accessible to everyone, even those who aren't of the server. private is only accessible to explicitly mentioned users. Currently, threads cannot be public and other channels cannot be private. Additionally, private threads can only exist with an associated messageId that is for a private message. At this time, you cannot update the visibility on a channel to private; this must be set at creation

  Returns CancelablePromise<{
      channel: ServerChannelPayload;
  }>

  any Success