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

    Class CommandManager

    Hierarchy

    • CommandExecutor
      • CommandManager
    Index

    Constructors

    Methods

    _execute apikeyadd apikeydel apikeylist banadd banclient bandel bandelall banlist bindinglist channeladdperm channelclientaddperm channelclientdelperm channelclientpermlist channelcreate channeldelete channeldelperm channeledit channelfind channelgroupadd channelgroupaddperm channelgroupclientlist channelgroupcopy channelgroupdel channelgroupdelperm channelgrouplist channelgrouppermlist channelgrouprename channelinfo channellist channelmove channelpermlist clientaddperm clientdbdelete clientdbedit clientdbfind clientdbinfo clientdblist clientdelperm clientedit clientfind clientgetdbidfromuid clientgetids clientgetnamefromdbid clientgetnamefromuid clientgetuidfromclid clientinfo clientkick clientlist clientmove clientpermlist clientpoke clientsetserverquerylogin clientupdate complainadd complaindel complaindelall complainlist customdelete custominfo customsearch customset ftcreatedir ftdeletefile ftgetfileinfo ftgetfilelist ftinitdownload ftinitupload ftlist ftrenamefile ftstop gm help hostinfo instanceedit instanceinfo logadd login logout logview messageadd messagedel messageget messagelist messageupdateflag permfind permget permidgetbyname permissionlist permoverview permreset privilegekeyadd privilegekeydelete privilegekeylist privilegekeyuse queryloginadd querylogindel queryloginlist quit registerTransportEvents sendtextmessage servercreate serverdelete serveredit servergroupadd servergroupaddclient servergroupaddperm servergroupautoaddperm servergroupautodelperm servergroupclientlist servergroupcopy servergroupdel servergroupdelclient servergroupdelperm servergrouplist servergrouppermlist servergrouprename servergroupsbyclientid serveridgetbyport serverinfo serverlist servernotifyregister servernotifyunregister serverprocessstop serverrequestconnectioninfo serversnapshotcreate serversnapshotdeploy serverstart serverstop servertemppasswordadd servertemppassworddel servertemppasswordlist setclientchannelgroup tokenadd tokendelete tokenlist tokenuse use version whoami

    Constructors

    Methods

    • Type Parameters

      • TData = unknown

      Parameters

      • name: string
      • Optionalparams: Record<string, string | number | boolean | number[] | undefined>

      Returns Promise<TData>

    • Parameters

      • params: { _count?: true; cldbid: number | "*"; duration?: number; start?: number }

      Returns Promise<RawApiKey | RawApiKey[]>

    • Parameters

      • params: {
            banreason?: string;
            ip?: string;
            lastnickname?: string;
            mytsid?: string;
            name?: string;
            time?: number;
            uid?: string;
        }

      Returns Promise<void>

    • Parameters

      • params: { _continueonerror?: true; banreason?: string; clid: number; time?: number }

      Returns Promise<{ banid: string } | { banid: string }[]>

    • Parameters

      • params: {
            channel_codec?: number;
            channel_codec_quality?: number;
            channel_description?: string;
            channel_flag_default?: boolean;
            channel_flag_maxclients_unlimited?: boolean;
            channel_flag_maxfamilyclients_inherited?: boolean;
            channel_flag_maxfamilyclients_unlimited?: boolean;
            channel_flag_password?: boolean;
            channel_flag_permanent?: boolean;
            channel_flag_semi_permanent?: boolean;
            channel_flag_temporary?: boolean;
            channel_maxclients?: number;
            channel_maxfamilyclients?: number;
            channel_name: string;
            channel_name_phonetic?: string;
            channel_needed_talk_power?: number;
            channel_order?: number;
            channel_password?: string;
            channel_topic?: string;
        }

      Returns Promise<{ cid: string }>

    • Parameters

      • __namedParameters: { cid: number; force?: boolean }

      Returns Promise<void>

    • Parameters

      • params: {
            channel_banner_gfx_url?: string;
            channel_banner_mode?: number;
            channel_codec?: number;
            channel_codec_is_unencrypted?: boolean;
            channel_codec_quality?: number;
            channel_delete_delay?: number;
            channel_description?: string;
            channel_flag_default?: boolean;
            channel_flag_maxclients_unlimited?: boolean;
            channel_flag_maxfamilyclients_inherited?: boolean;
            channel_flag_maxfamilyclients_unlimited?: boolean;
            channel_flag_permanent?: boolean;
            channel_flag_semi_permanent?: boolean;
            channel_icon_id?: number;
            channel_maxclients?: number;
            channel_maxfamilyclients?: number;
            channel_name?: string;
            channel_name_phonetic?: string;
            channel_needed_talk_power?: number;
            channel_order?: number;
            channel_password?: string;
            channel_topic?: string;
            cid: number;
            cpid?: number;
        }

      Returns Promise<void>

    • Parameters

      • params: { name: string; type?: number }

      Returns Promise<{ cgid: string }>

    • Parameters

      • params: { name?: string; scgid: number; tcgid?: number; type?: number }

      Returns Promise<{ cgid: string }>

    • Parameters

      • params: { cgid: number; force?: boolean }

      Returns Promise<void>

    • Parameters

      • params: { cgid: number; name: string }

      Returns Promise<void>

    • Parameters

      • params: {
            _banners?: true;
            _flags?: true;
            _icon?: true;
            _limits?: true;
            _secondsempty?: true;
            _topic?: true;
            _voice?: true;
        } = {}

      Returns Promise<RawChannelListItem[]>

    • Parameters

      • params: { cid: number; cpid: number; order?: number }

      Returns Promise<void>

    • Parameters

      • params: { cldbid: number }

      Returns Promise<void>

    • Parameters

      • params: {
            clid: number;
            client_description?: string;
            client_icon_id?: number;
            client_is_channel_commander?: boolean;
            client_is_talker?: boolean;
            client_nickname?: string;
        }

      Returns Promise<void>

    • Parameters

      • params: { _continueonerror?: true; clid: number; reasonid: number; reasonmsg?: string }

      Returns Promise<void>

    • Parameters

      • params: {
            _away?: true;
            _badges?: true;
            _country?: true;
            _groups?: true;
            _icon?: true;
            _info?: true;
            _ip?: true;
            _times?: true;
            _uid?: true;
            _voice?: true;
        } = {}

      Returns Promise<RawClient | RawClient[]>

    • Parameters

      • params: { _continueonerror?: true; cid: number; clid: number; cpw?: string }

      Returns Promise<void>

    • Parameters

      • params: { clid: number; msg: string }

      Returns Promise<void>

    • Parameters

      • params: { client_login_name: string }

      Returns Promise<{ client_login_password: string }>

    • Parameters

      • params: { client_nickname?: string }

      Returns Promise<void>

    • Parameters

      • params: { message: string; tcldbid: number }

      Returns Promise<void>

    • Parameters

      • params: { fcldbid: number; tcldbid: number }

      Returns Promise<void>

    • Parameters

      • params: { tcldbid: number }

      Returns Promise<void>

    • Parameters

      • params: { loglevel: number; logmsg: string }

      Returns Promise<void>

    • Parameters

      • params: { client_login_name: string; client_login_password: string }

      Returns Promise<void>

    • Parameters

      • params: { begin_pos?: number; instance?: boolean; lines?: number; reverse?: boolean } = {}

      Returns Promise<RawLogView | RawLogViewItem[]>

    • Parameters

      • params: { permsid: string }

      Returns Promise<{ permid: string; permsid: string }>

    • Parameters

      • params: {
            customset?: string;
            tokendescription?: string;
            tokenid1: number;
            tokenid2: number;
            tokentype: number;
        }

      Returns Promise<{ token: string }>

    • Parameters

      • params: { token: string }

      Returns Promise<void>

    • Parameters

      • params: { token: string }

      Returns Promise<void>

    • Parameters

      • params: { cldbid: number }

      Returns Promise<void>

    • Parameters

      • params: { msg: string; target: number; targetmode: number }

      Returns Promise<void>

    • Parameters

      • params: {
            virtualserver_autostart?: boolean;
            virtualserver_codec_encryption_mode?: string;
            virtualserver_default_channel_group?: number;
            virtualserver_default_server_group?: number;
            virtualserver_encryption_ciphers?: string;
            virtualserver_hostbanner_gfx_interval?: number;
            virtualserver_hostbanner_gfx_url?: string;
            virtualserver_hostbanner_url?: string;
            virtualserver_hostmessage?: string;
            virtualserver_hostmessage_mode?: number;
            virtualserver_machine_id?: string;
            virtualserver_maxclients?: number;
            virtualserver_name: string;
            virtualserver_password?: string;
            virtualserver_port?: number;
            virtualserver_weblist_enabled?: boolean;
            virtualserver_welcomemessage?: string;
        }

      Returns Promise<RawCreatedVirtualServer>

    • Parameters

      • params: {
            virtualserver_antiflood_points_needed_command_block?: number;
            virtualserver_antiflood_points_needed_ip_block?: number;
            virtualserver_antiflood_points_needed_plugin_block?: number;
            virtualserver_antiflood_points_tick_reduce?: number;
            virtualserver_autostart?: boolean;
            virtualserver_codec_encryption_mode?: string;
            virtualserver_complain_autoban_count?: number;
            virtualserver_complain_autoban_time?: number;
            virtualserver_complain_remove_time?: number;
            virtualserver_default_channel_admin_group?: number;
            virtualserver_default_channel_group?: number;
            virtualserver_default_server_group?: number;
            virtualserver_download_quota?: number;
            virtualserver_hostbanner_gfx_interval?: number;
            virtualserver_hostbanner_gfx_url?: string;
            virtualserver_hostbanner_mode?: number;
            virtualserver_hostbanner_url?: string;
            virtualserver_hostbutton_gfx_url?: string;
            virtualserver_hostbutton_tooltip?: string;
            virtualserver_hostbutton_url?: string;
            virtualserver_hostmessage?: string;
            virtualserver_hostmessage_mode?: number;
            virtualserver_icon_id?: number;
            virtualserver_log_channel?: boolean;
            virtualserver_log_client?: boolean;
            virtualserver_log_filetransfer?: boolean;
            virtualserver_log_permissions?: boolean;
            virtualserver_log_query?: boolean;
            virtualserver_log_server?: boolean;
            virtualserver_max_download_total_bandwidth?: number;
            virtualserver_max_upload_total_bandwidth?: number;
            virtualserver_maxclients?: number;
            virtualserver_min_android_version?: number;
            virtualserver_min_client_version?: number;
            virtualserver_min_clients_in_channel_before_forced_silence?: number;
            virtualserver_min_ios_version?: number;
            virtualserver_name?: string;
            virtualserver_name_phonetic?: string;
            virtualserver_needed_identity_security_level?: number;
            virtualserver_password?: string;
            virtualserver_port?: number;
            virtualserver_priority_speaker_dimm_modificator?: number;
            virtualserver_reserved_slots?: number;
            virtualserver_status?: string;
            virtualserver_upload_quota?: number;
            virtualserver_weblist_enabled?: boolean;
            virtualserver_welcomemessage?: string;
        }

      Returns Promise<void>

    • Parameters

      • params: { name: string; type?: number }

      Returns Promise<{ sgid: string }>

    • Parameters

      • params: { _continueonerror?: true; cldbid: number; sgid: number }

      Returns Promise<void>

    • Parameters

      • params: {
            permid?: number;
            permnegated?: boolean;
            permsid?: string;
            permskip?: boolean;
            permvalue?: number;
            sgid: number;
        }

      Returns Promise<void>

    • Parameters

      • params: { name?: string; ssgid: number; tsgid?: number; type?: ServerGroupType }

      Returns Promise<{ sgid: string }>

    • Parameters

      • params: { force?: boolean; sgid: number }

      Returns Promise<void>

    • Parameters

      • params: { _continueonerror?: true; cldbid: number; sgid: number }

      Returns Promise<void>

    • Parameters

      • params: { _continueonerror?: true; permid?: number; permsid?: string; sgid: number }

      Returns Promise<void>

    • Parameters

      • params: { name: string; sgid: number }

      Returns Promise<void>

    • Parameters

      • params: { virtualserver_port: number }

      Returns Promise<{ server_id: string }>

    • Parameters

      • params: { event: string; id?: number }

      Returns Promise<void>

    • Parameters

      • params: { reasonmsg?: string }

      Returns Promise<void>

    • Parameters

      • params: {
            _keepfiles?: true;
            _mapping?: true;
            data: string;
            password?: string;
            salt?: string;
            version: number;
        }

      Returns Promise<unknown>

    • Parameters

      • params: { reasonmsg?: string; sid: number }

      Returns Promise<void>

    • Parameters

      • params: { desc: string; duration: number; pw: string; tcid?: string; tcpw?: string }

      Returns Promise<void>

    • Parameters

      • params: { pw: string }

      Returns Promise<void>

    • Parameters

      • params: { cgid: number; cid: number; cldbid: number }

      Returns Promise<void>

    • Parameters

      • params: { client_nickname?: string; port?: number; sid?: number }

      Returns Promise<void>