Class Channel

constructor

• new Channel(
      data: {
          archivedAt?: string;
          archivedBy?: string;
          categoryId?: number;
          createdAt: string;
          createdBy: string;
          groupId: string;
          id: string;
          messageId?: string;
          name: string;
          parentId?: string;
          priority?: number;
          rootId?: string;
          serverId: string;
          topic?: string;
          type: ServerChannelType;
          updatedAt?: string;
          visibility?: null | "private" | "public";
      },
      client: Client,
  ): Channel

  Parameters

  • data: {
        archivedAt?: string;
        archivedBy?: string;
        categoryId?: number;
        createdAt: string;
        createdBy: string;
        groupId: string;
        id: string;
        messageId?: string;
        name: string;
        parentId?: string;
        priority?: number;
        rootId?: string;
        serverId: string;
        topic?: string;
        type: ServerChannelType;
        updatedAt?: string;
        visibility?: null | "private" | "public";
    }

    raw data

    • OptionalarchivedAt?: string

      Archived at Format: date-time

      Description

      The ISO 8601 timestamp that the channel was archived at, if relevant

    • OptionalarchivedBy?: string

      Archived by

      Description

      The ID of the user who archived this channel

    • OptionalcategoryId?: number

      Description

      The category that the channel exists in. Only relevant for server channels

    • createdAt: string

      Created at Format: date-time

      Description

      The ISO 8601 timestamp that the channel was created at

    • createdBy: string

      Created by

      Description

      The ID of the user who created this channel

    • groupId: string

      Group ID

      Description

      The ID of the group

    • id: string

      Channel ID Format: uuid

      Description

      The ID of the channel

    • OptionalmessageId?: string

      Message ID Format: uuid

      Description

      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

      Description

      The name of the channel

    • OptionalparentId?: string

      Channel ID Format: uuid

      Description

      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

    • Optionalpriority?: number

      Priority

      Description

      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

    • OptionalrootId?: string

      Channel ID Format: uuid

      Description

      ID of the root 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

    • serverId: string

      Server ID

      Description

      The ID of the server

    • Optionaltopic?: string

      Description

      The topic of the channel. Not applicable to threads

    • type: ServerChannelType

      Description

      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

    • OptionalupdatedAt?: string

      Updated at Format: date-time

      Description

      The ISO 8601 timestamp that the channel was updated at, if relevant

    • Optionalvisibility?: null | "private" | "public"

      Description

      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

  • client: Client

    client

  Returns Channel

name

type

delete

• delete(): Promise<void>

  Delete the channel.

  Returns Promise<void>

edit

• edit(options: EditChannelOptions): Promise<Channel>

  Edit the channel.

  Parameters

  • options: EditChannelOptions

  Returns Promise<Channel>

toJSON

• toJSON(): JSONChannel

  Returns JSONChannel

Staticfrom

• from<T extends AnyChannel = AnyChannel>(
      data: {
          archivedAt?: string;
          archivedBy?: string;
          categoryId?: number;
          createdAt: string;
          createdBy: string;
          groupId: string;
          id: string;
          messageId?: string;
          name: string;
          parentId?: string;
          priority?: number;
          rootId?: string;
          serverId: string;
          topic?: string;
          type: ServerChannelType;
          updatedAt?: string;
          visibility?: null | "private" | "public";
      },
      client: Client,
  ): T

  Type Parameters

  • T extends AnyChannel = AnyChannel

  Parameters

  • data: {
        archivedAt?: string;
        archivedBy?: string;
        categoryId?: number;
        createdAt: string;
        createdBy: string;
        groupId: string;
        id: string;
        messageId?: string;
        name: string;
        parentId?: string;
        priority?: number;
        rootId?: string;
        serverId: string;
        topic?: string;
        type: ServerChannelType;
        updatedAt?: string;
        visibility?: null | "private" | "public";
    }

    • OptionalarchivedAt?: string

      Archived at Format: date-time

      Description

      The ISO 8601 timestamp that the channel was archived at, if relevant

    • OptionalarchivedBy?: string

      Archived by

      Description

      The ID of the user who archived this channel

    • OptionalcategoryId?: number

      Description

      The category that the channel exists in. Only relevant for server channels

    • createdAt: string

      Created at Format: date-time

      Description

      The ISO 8601 timestamp that the channel was created at

    • createdBy: string

      Created by

      Description

      The ID of the user who created this channel

    • groupId: string

      Group ID

      Description

      The ID of the group

    • id: string

      Channel ID Format: uuid

      Description

      The ID of the channel

    • OptionalmessageId?: string

      Message ID Format: uuid

      Description

      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

      Description

      The name of the channel

    • OptionalparentId?: string

      Channel ID Format: uuid

      Description

      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

    • Optionalpriority?: number

      Priority

      Description

      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

    • OptionalrootId?: string

      Channel ID Format: uuid

      Description

      ID of the root 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

    • serverId: string

      Server ID

      Description

      The ID of the server

    • Optionaltopic?: string

      Description

      The topic of the channel. Not applicable to threads

    • type: ServerChannelType

      Description

      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

    • OptionalupdatedAt?: string

      Updated at Format: date-time

      Description

      The ISO 8601 timestamp that the channel was updated at, if relevant

    • Optionalvisibility?: null | "private" | "public"

      Description

      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

  • client: Client

  Returns T