Class Channel

constructor

• new Channel(query: Query, data: Partial<RawChannel>): Channel

  Parameters

  • query: Query
  • data: Partial<RawChannel>

  Returns Channel

bannerGfxUrl

bannerMode

codec

codecQuality

codecUnencrypted

default

deleteDelay

description

filepath

forcedSilence

iconId

latencyFactor

maxClients

maxClientsUnlimited

maxFamilyClients

maxFamilyClientsInherited

maxFamilyClientsUnlimited

name

namePhonetic

neededTalkPower

order

parentId

password

secondsEmpty

securitySalt

topic

type

uniqueId

children

• get children(): Collection<number, Channel>

  Gets the child channels of this channel.

  Returns Collection<number, Channel>

  The child channels.

parent

• get parent(): Channel | null

  Gets the parent channel of this channel.

  Returns Channel | null

  The parent channel, or null if there is none.

partial

• get partial(): boolean

  Checks if the channel is partially filled.

  Returns boolean

  Whether the channel is partially filled.

_patch

• _patch(data: Partial<RawChannel>): void

  Patches the channel with new data.

  Parameters

  • data: Partial<RawChannel>

    The new data to patch the channel with.

  Returns void

delete

• delete(force?: boolean): Promise<void>

  Deletes the channel.

  Parameters

  • Optionalforce: boolean = false

    Whether to force the deletion. Forcing deletion will kick all clients from the channel.

  Returns Promise<void>

edit

• edit(data: ChannelEditOptions): Promise<Channel>

  Edits the channel with new data.

  Parameters

  • data: ChannelEditOptions

    The new data to patch the channel with.

  Returns Promise<Channel>

  The updated channel.

fetch

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

  Fetches the channel from the server or the cache.

  Parameters

  • Optionalforce: boolean = false

    Whether to force a fetch from the server.

  Returns Promise<Channel>

  The fetched channel.

kickClient

• kickClient(client: ClientResolvable, reason?: string): Promise<void>

  Kicks a client from the channel.

  Parameters

  • client: ClientResolvable

    The client to kick.

  • Optionalreason: string

    The reason for the kick.

  Returns Promise<void>

move

• move(options: ChannelMoveOptions): Promise<Channel>

  Moves the channel.

  Parameters

  • options: ChannelMoveOptions

    The options for moving the channel.

  Returns Promise<Channel>

  The moved channel.