Class ServerChannel

Readonlyclient

id

type

createdAt

• get createdAt(): Date

  Gets the date and time when the channel was created.

  Returns Date

  The creation date of the channel.

createdTimestamp

• get createdTimestamp(): number

  Gets the timestamp (in milliseconds) when the channel was created.

  Returns number

  The timestamp of the channel's creation.

_clone

• _clone(): this

  Creates a deep clone of the object.

  Returns this

  A clone of the object.

_update

• _update(data: PartialObject, clear?: string[]): this

  Updates the object with new data and returns a clone of the object.

  Parameters

  • data: PartialObject

    The data to update the object with.
  • Optionalclear: string[]

    Fields to clear in the object.

  Returns this

  A clone of the updated object.

delete

• delete(): Promise<void>

  Deletes the current channel instance from the client's channel collection.

  This method interacts with the client's channel management system to remove the channel. Once deleted, the channel will no longer be accessible through the client.

  Returns Promise<void>

  A promise that resolves when the channel has been successfully deleted.

  Example

  const channel = client.channels.get('1234567890');
  if (channel) {
    await channel.delete();
    console.log('Channel deleted successfully.');
  }
  Copy

equals

• equals(obj?: null | ServerChannel): boolean

  Compares this object with another to determine if they are equal.

  Parameters

  • Optionalobj: null | ServerChannel

    The object to compare with.

  Returns boolean

  true if the objects are equal, otherwise false.

fetch

• fetch(force?: boolean): Promise<Channel>

  Fetches the latest data for the channel from the client's channel collection.

  Parameters

  • Optionalforce: boolean = true

    Whether to force a fetch even if the channel is cached.

  Returns Promise<Channel>

  A promise that resolves with the updated channel instance.

inServer

• inServer(): this is ServerChannel

  Checks if the channel is part of a server.

  Returns this is ServerChannel

  True if the channel is a server channel, otherwise false.

isGroup

• isGroup(): this is GroupChannel

  Checks if the channel is a group channel.

  Returns this is GroupChannel

  True if the channel is a group channel, otherwise false.

isText

• isText(): this is DMChannel | TextChannel | GroupChannel

  Checks if the channel is a text-based channel.

  Returns this is DMChannel | TextChannel | GroupChannel

  True if the channel is a text-based channel, otherwise false.

isVoice

• isVoice(): this is VoiceChannel

  Checks if the channel is a voice channel.

  Returns this is VoiceChannel

  True if the channel is a voice channel, otherwise false.

toString

• toString(): string

  Converts the channel to a string representation.

  Returns string

  A string representation of the channel in the format <#channelId>.