Class Channel

constructor

• new Channel(client, data): Channel

• Parameters

  • client: Client

  • data: Omit<ServerChannelPayload, "visibility"> & {
        deleted?: boolean;
        visibility?: null | "" | "private" | "public";
    }

  Returns Channel

_archivedAt

_createdAt

_updatedAt

archivedBy

categoryId

createdBy

groupId

name

parentId

serverId

topic

type

visibility

archivedAt

• get archivedAt(): null | Date

• The timestamp when the channel was archived as a Date object, or null if the channel is not archived.

  Returns null | Date

createdAt

• get createdAt(): Date

• The timestamp when the channel was created as a Date object.

  Returns Date

updatedAt

• get updatedAt(): null | Date

• The timestamp when the channel was last updated as a Date object, or null if the channel has not been updated.

  Returns null | Date

_update

• _update(data): Channel

• Parameters

  • data: Partial<Omit<ServerChannelPayload, "visibility"> & {
        deleted?: boolean;
        visibility?: null | "" | "private" | "public";
    }>

  Returns Channel

delete

• delete(): Promise<null | Channel>

• Delete the channel.

  Returns Promise<null | Channel>

fetchMessage

• fetchMessage(messageId): Promise<Message>

• Fetch details for a specific message in the channel.

  Parameters

  • messageId: string

    The ID of the message to fetch.

  Returns Promise<Message>

fetchMessages

• fetchMessages(options?): Promise<Collection<string, Message>>

• Fetch from the latest 100 messages in the channel.

  Parameters

  • Optional options: unknown

    Additional options for the message fetch.

  Returns Promise<Collection<string, Message>>

send

• send(content): Promise<Message>

• Send a message in the channel.

  Example

  let replyObj = {
   content: 'This is text, supports **markdown**.',
   embeds: [{
     title: 'This is an embed title!',
     description: 'A description may go here'
   }]
  };
  channel.send(replyObj)
  Copy

  Parameters

  • content: MessageContent

    The content of the message.

  Returns Promise<Message>

update

• update(options): Promise<Channel>

• Update the channel with new data.

  Parameters

  • options: {}

    The new data for the channel.

  Returns Promise<Channel>