teamspeak.js - v1.11.0
    Preparing search index...

    Class ClientManager

    Manages the clients in the TeamSpeak server.

    Hierarchy (View Summary)

    Index

    Constructors

    Accessors

    Methods

    • Deletes the database properties of a client.

      Parameters

      • clientDatabaseId: number

        The ID of the client.

      Returns Promise<void>

      A promise that resolves when the database properties have been deleted.

    • Kicks a client from the current channel.

      Parameters

      • client: ClientResolvable

        The client to kick.

      • Optionalreason: string

        The reason for the kick.

      Returns Promise<void>

      A promise that resolves when the client has been kicked.

    • Kicks a client from the server.

      Parameters

      • client: ClientResolvable

        The client to kick.

      • Optionalreason: string

        The reason for the kick.

      Returns Promise<void>

      A promise that resolves when the client has been kicked.

    • Searches for clients based on the client nickname.

      Parameters

      • query: string

        The search query.

      Returns Promise<Collection<number, Client>>

      The found clients.

    • Searches for clients based on the client nickname or unique ID.

      Supports SQL-like pattern matching with "%"

      Parameters

      • options:
            | { nickname: string; uniqueId?: undefined }
            | { nickname?: undefined; uniqueId: string }

        The options for searching the client.

        • { nickname: string; uniqueId?: undefined }
          • nickname: string

            The nickname to search for.

          • OptionaluniqueId?: undefined
        • { nickname?: undefined; uniqueId: string }
          • Optionalnickname?: undefined
          • uniqueId: string

            The unique ID to search for.

      Returns Promise<number[]>

      The found clients database IDs

    • Sends a message to a client.

      Parameters

      • client: ClientResolvable

        The client to send the message to.

      • content: string

        The content of the message.

      Returns Promise<void>

      A promise that resolves when the message has been sent.