Class Client

constructor

• new Client(query: Query, data: RawClient): Client

  Parameters

  • query: Query
  • data: RawClient

  Returns Client

channelId

databaseId

description

nickname

type

uniqueId

channel

• get channel(): Channel | null

  Gets the channel the client is in.

  Returns Channel | null

  The channel the client is in, or null if unknown.

partial

• get partial(): boolean

  Checks if the client is partially filled.

  Returns boolean

  Whether the client is partially filled.

_patch

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

  Patches the client with new data.

  Parameters

  • data: Partial<RawClient>

    The new data to patch the client with.

  Returns void

addServerGroup

• addServerGroup(serverGroup: ServerGroupResolvable): Promise<void>

  Adds a server group to the client.

  Parameters

  • serverGroup: ServerGroupResolvable

    The server group to add.

  Returns Promise<void>

  A promise that resolves when the server group has been added.

ban

• ban(options?: BanClientOptions): Promise<Collection<number, Ban>>

  Bans the client from the server. Since TeamSpeak creates multiple ban entries for one client, this returns a collection of bans.

  Parameters

  • options: BanClientOptions = {}

    The options for the ban.

  Returns Promise<Collection<number, Ban>>

  The bans applied to the client. TeamSpeak creates multiple ban entries for one client.

edit

• edit(data: ClientEditOptions): Promise<Client>

  Edits the client with new data.

  Parameters

  • data: ClientEditOptions

    The new data to patch the client with.

  Returns Promise<Client>

  The updated client.

fetch

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

  Fetches the client from the server or the cache.

  Parameters

  • Optionalforce: boolean = false

    Whether to force the fetch.

  Returns Promise<Client>

  The fetched client.

fetchServerGroups

• fetchServerGroups(): Promise<Collection<number, ServerGroup>>

  Fetches the server groups the client belongs to.

  Returns Promise<Collection<number, ServerGroup>>

  The server groups the client belongs to.

kickFromChannel

• kickFromChannel(reason?: string): Promise<void>

  Kicks the client from the current channel.

  Parameters

  • Optionalreason: string

    The reason for the kick.

  Returns Promise<void>

  A promise that resolves when the client has been kicked.

kickFromServer

• kickFromServer(reason?: string): Promise<void>

  Kicks the client from the server.

  Parameters

  • Optionalreason: string

    The reason for the kick.

  Returns Promise<void>

  A promise that resolves when the client has been kicked.

move

• move(channel: ChannelResolvable, channelPassword?: string): Promise<Client>

  Moves the client to a different channel.

  Parameters

  • channel: ChannelResolvable

    The channel to move the client to.

  • OptionalchannelPassword: string

    The password for the channel, if required.

  Returns Promise<Client>

  A promise that resolves to the moved client.

poke

• poke(content: string): Promise<void>

  Pokes the client.

  Parameters

  • content: string

    The content of the poke message.

  Returns Promise<void>

  A promise that resolves when the poke has been sent.

removeServerGroup

• removeServerGroup(serverGroup: ServerGroupResolvable): Promise<void>

  Removes a server group from the client.

  Parameters

  • serverGroup: ServerGroupResolvable

    The server group to remove.

  Returns Promise<void>

  A promise that resolves when the server group has been removed.

sendMessage

• sendMessage(content: string): Promise<void>

  Sends a message to the client.

  Parameters

  • content: string

    The content of the message.

  Returns Promise<void>

  A promise that resolves when the message has been sent.

setChannelGroup

• setChannelGroup(
      channel: ChannelResolvable,
      channelGroup: ChannelGroupResolvable,
  ): Promise<void>

  Sets a channel group for the client in a channel.

  Parameters

  • channel: ChannelResolvable

    The channel to set the channel group for.

  • channelGroup: ChannelGroupResolvable

    The channel group to set for the client.

  Returns Promise<void>

  A promise that resolves when the channel group has been set.

setDescription

• setDescription(description: string): Promise<Client>

  Sets the description of the client.

  Parameters

  • description: string

    The new description.

  Returns Promise<Client>

  The updated client.

setTalker

• setTalker(isTalker: boolean): Promise<Client>

  Sets whether the client is a talker.

  Parameters

  • isTalker: boolean

    Whether the client is a talker.

  Returns Promise<Client>

  The updated client.

toString

• toString(): string

  Converts the client to a string representation.

  Returns string

  The string representation of the client.