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

    Type Alias EventTypes

    The events of the TeamSpeak server.

    type EventTypes = {
        BanCreate: [ban: Ban];
        BanDelete: [ban: Ban];
        ChannelCreate: [channel: Channel, invoker: Client];
        ChannelDelete: [channel: Channel, invoker: Client];
        ChannelGroupCreate: [channelGroup: ChannelGroup];
        ChannelGroupDelete: [channelGroup: ChannelGroup];
        ChannelGroupUpdate: [before: ChannelGroup, after: ChannelGroup];
        ChannelUpdate: [before: Channel, after: Channel, invoker: Client];
        ClientEnterView: [client: Client];
        ClientLeaveView: [client: Client];
        ClientMove: [
            client: Client,
            oldChannel: Channel
            | null,
            newChannel: Channel,
            invoker: Client | null,
        ];
        ClientUpdate: [before: Client, after: Client];
        Close: [];
        Debug: [message: string];
        Error: [error: unknown];
        PrivilegeKeyCreate: [privilegeKey: PrivilegeKey];
        PrivilegeKeyDelete: [privilegeKey: PrivilegeKey];
        Ready: [];
        ServerGroupCreate: [serverGroup: ServerGroup];
        ServerGroupDelete: [serverGroup: ServerGroup];
        ServerGroupUpdate: [before: ServerGroup, after: ServerGroup];
        TextMessage: [textMessage: TextMessage];
        VirtualServerCreate: [virtualServer: VirtualServer];
        VirtualServerDelete: [virtualServer: VirtualServer];
        VirtualServerUpdate: [before: VirtualServer, after: VirtualServer];
    }
    Index

    Properties

    BanCreate BanDelete ChannelCreate ChannelDelete ChannelGroupCreate ChannelGroupDelete ChannelGroupUpdate ChannelUpdate ClientEnterView ClientLeaveView ClientMove ClientUpdate Close Debug Error PrivilegeKeyCreate PrivilegeKeyDelete Ready ServerGroupCreate ServerGroupDelete ServerGroupUpdate TextMessage VirtualServerCreate VirtualServerDelete VirtualServerUpdate

    Properties

    BanCreate: [ban: Ban]

    The event when a ban is created. Includes the ban.

    BanDelete: [ban: Ban]

    The event when a ban is deleted. Includes the ban.

    ChannelCreate: [channel: Channel, invoker: Client]

    The event when a channel is created. Includes the channel and the invoker.

    ChannelDelete: [channel: Channel, invoker: Client]

    The event when a channel is deleted. Includes the channel and the invoker.

    ChannelGroupCreate: [channelGroup: ChannelGroup]

    The event when a channel group is created. Includes the channel group.

    ChannelGroupDelete: [channelGroup: ChannelGroup]

    The event when a channel group is deleted. Includes the channel group.

    ChannelGroupUpdate: [before: ChannelGroup, after: ChannelGroup]

    The event when a channel group is updated. Includes the before and after state of the channel group.

    ChannelUpdate: [before: Channel, after: Channel, invoker: Client]

    The event when a channel is updated. Includes the before and after state of the channel and the invoker.

    ClientEnterView: [client: Client]

    The event when a client enters a view. Includes the client.

    ClientLeaveView: [client: Client]

    The event when a client leaves a view. Includes the client.

    ClientMove: [
        client: Client,
        oldChannel: Channel
        | null,
        newChannel: Channel,
        invoker: Client | null,
    ]

    The event when a client moves. Includes the client, the old channel, the new channel and the invoker. The oldChannel can be null if the old channel is not known. Invoker is null, if the client moved on their own.

    ClientUpdate: [before: Client, after: Client]

    The event when a client is updated. Includes the before and after state of the client.

    Close: []

    The event when the client is closed.

    Debug: [message: string]

    The event when a debug message is received. Includes the message.

    Error: [error: unknown]

    The event when an error occurs. Includes the error.

    PrivilegeKeyCreate: [privilegeKey: PrivilegeKey]

    The event when a privilege key is created. Includes the privilege key.

    PrivilegeKeyDelete: [privilegeKey: PrivilegeKey]

    The event when a privilege key is deleted. Includes the privilege key.

    Ready: []

    The event when the client is ready.

    ServerGroupCreate: [serverGroup: ServerGroup]

    The event when a server group is created. Includes the server group.

    ServerGroupDelete: [serverGroup: ServerGroup]

    The event when a server group is deleted. Includes the server group.

    ServerGroupUpdate: [before: ServerGroup, after: ServerGroup]

    The event when a server group is updated. Includes the before and after state of the server group.

    TextMessage: [textMessage: TextMessage]

    The event when a text message is received. Includes the text message.

    VirtualServerCreate: [virtualServer: VirtualServer]

    The event when a virtual server is created. Includes the virtual server.

    VirtualServerDelete: [virtualServer: VirtualServer]

    The event when a virtual server is deleted. Includes the virtual server.

    VirtualServerUpdate: [before: VirtualServer, after: VirtualServer]

    The event when a virtual server is updated. Includes the before and after state of the virtual server.

    Settings

    Member Visibility

    On This Page

    Properties