teamspeak.js - v1.11.0
Preparing search index...
CommandManager
Class CommandManager
Hierarchy
CommandExecutor
CommandManager
Index
Constructors
constructor
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
register
Transport
Events
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
constructor
new
CommandManager
(
query
:
Query
)
:
CommandManager
Parameters
query
:
Query
Returns
CommandManager
Methods
_
execute
_execute
<
TData
=
unknown
>
(
name
:
string
,
params
?:
Record
<
string
,
string
|
number
|
boolean
|
number
[]
|
undefined
>
,
)
:
Promise
<
TData
>
Type Parameters
TData
=
unknown
Parameters
name
:
string
Optional
params
:
Record
<
string
,
string
|
number
|
boolean
|
number
[]
|
undefined
>
Returns
Promise
<
TData
>
apikeyadd
apikeyadd
(
params
:
{
cldbid
?:
number
;
lifetime
?:
number
;
scope
:
string
}
,
)
:
Promise
<
RawApiKey
>
Parameters
params
:
{
cldbid
?:
number
;
lifetime
?:
number
;
scope
:
string
}
Returns
Promise
<
RawApiKey
>
apikeydel
apikeydel
(
params
:
{
id
:
number
}
)
:
Promise
<
void
>
Parameters
params
:
{
id
:
number
}
Returns
Promise
<
void
>
apikeylist
apikeylist
(
params
:
{
_count
?:
true
;
cldbid
:
number
|
"*"
;
duration
?:
number
;
start
?:
number
;
}
,
)
:
Promise
<
RawApiKey
|
RawApiKey
[]
>
Parameters
params
:
{
_count
?:
true
;
cldbid
:
number
|
"*"
;
duration
?:
number
;
start
?:
number
}
Returns
Promise
<
RawApiKey
|
RawApiKey
[]
>
banadd
banadd
(
params
:
{
banreason
?:
string
;
ip
?:
string
;
lastnickname
?:
string
;
mytsid
?:
string
;
name
?:
string
;
time
?:
number
;
uid
?:
string
;
}
,
)
:
Promise
<
void
>
Parameters
params
:
{
banreason
?:
string
;
ip
?:
string
;
lastnickname
?:
string
;
mytsid
?:
string
;
name
?:
string
;
time
?:
number
;
uid
?:
string
;
}
Returns
Promise
<
void
>
banclient
banclient
(
params
:
{
_continueonerror
?:
true
;
banreason
?:
string
;
clid
:
number
;
time
?:
number
;
}
,
)
:
Promise
<
{
banid
:
string
}
|
{
banid
:
string
}
[]
>
Parameters
params
:
{
_continueonerror
?:
true
;
banreason
?:
string
;
clid
:
number
;
time
?:
number
}
Returns
Promise
<
{
banid
:
string
}
|
{
banid
:
string
}
[]
>
bandel
bandel
(
params
:
{
banid
:
number
}
)
:
Promise
<
void
>
Parameters
params
:
{
banid
:
number
}
Returns
Promise
<
void
>
bandelall
bandelall
()
:
Promise
<
void
>
Returns
Promise
<
void
>
banlist
banlist
(
params
?:
{
_count
?:
true
;
duration
?:
number
;
start
?:
number
}
,
)
:
Promise
<
RawBan
|
RawBan
[]
>
Parameters
params
:
{
_count
?:
true
;
duration
?:
number
;
start
?:
number
}
= {}
Returns
Promise
<
RawBan
|
RawBan
[]
>
bindinglist
bindinglist
(
params
:
{
subsystem
?:
"query"
|
"voice"
|
"filetransfer"
}
,
)
:
Promise
<
RawBinding
|
RawBinding
[]
>
Parameters
params
:
{
subsystem
?:
"query"
|
"voice"
|
"filetransfer"
}
Returns
Promise
<
RawBinding
|
RawBinding
[]
>
channeladdperm
channeladdperm
()
:
void
Returns
void
channelclientaddperm
channelclientaddperm
()
:
void
Returns
void
channelclientdelperm
channelclientdelperm
()
:
void
Returns
void
channelclientpermlist
channelclientpermlist
()
:
void
Returns
void
channelcreate
channelcreate
(
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
;
}
,
)
:
Promise
<
{
cid
:
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
}
>
channeldelete
channeldelete
(
__namedParameters
:
{
cid
:
number
;
force
?:
boolean
}
,
)
:
Promise
<
void
>
Parameters
__namedParameters
:
{
cid
:
number
;
force
?:
boolean
}
Returns
Promise
<
void
>
channeldelperm
channeldelperm
()
:
void
Returns
void
channeledit
channeledit
(
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
;
}
,
)
:
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
>
channelfind
channelfind
(
params
:
{
pattern
:
string
}
,
)
:
Promise
<
RawChannelFindItem
|
RawChannelFindItem
[]
>
Parameters
params
:
{
pattern
:
string
}
Returns
Promise
<
RawChannelFindItem
|
RawChannelFindItem
[]
>
channelgroupadd
channelgroupadd
(
params
:
{
name
:
string
;
type
?:
number
}
,
)
:
Promise
<
{
cgid
:
string
}
>
Parameters
params
:
{
name
:
string
;
type
?:
number
}
Returns
Promise
<
{
cgid
:
string
}
>
channelgroupaddperm
channelgroupaddperm
()
:
void
Returns
void
channelgroupclientlist
channelgroupclientlist
()
:
void
Returns
void
channelgroupcopy
channelgroupcopy
(
params
:
{
name
?:
string
;
scgid
:
number
;
tcgid
?:
number
;
type
?:
number
}
,
)
:
Promise
<
{
cgid
:
string
}
>
Parameters
params
:
{
name
?:
string
;
scgid
:
number
;
tcgid
?:
number
;
type
?:
number
}
Returns
Promise
<
{
cgid
:
string
}
>
channelgroupdel
channelgroupdel
(
params
:
{
cgid
:
number
;
force
?:
boolean
}
)
:
Promise
<
void
>
Parameters
params
:
{
cgid
:
number
;
force
?:
boolean
}
Returns
Promise
<
void
>
channelgroupdelperm
channelgroupdelperm
()
:
void
Returns
void
channelgrouplist
channelgrouplist
()
:
Promise
<
RawChannelGroup
|
RawChannelGroup
[]
>
Returns
Promise
<
RawChannelGroup
|
RawChannelGroup
[]
>
channelgrouppermlist
channelgrouppermlist
()
:
void
Returns
void
channelgrouprename
channelgrouprename
(
params
:
{
cgid
:
number
;
name
:
string
}
)
:
Promise
<
void
>
Parameters
params
:
{
cgid
:
number
;
name
:
string
}
Returns
Promise
<
void
>
channelinfo
channelinfo
(
params
:
{
cid
:
number
}
)
:
Promise
<
RawChannel
>
Parameters
params
:
{
cid
:
number
}
Returns
Promise
<
RawChannel
>
channellist
channellist
(
params
?:
{
_banners
?:
true
;
_flags
?:
true
;
_icon
?:
true
;
_limits
?:
true
;
_secondsempty
?:
true
;
_topic
?:
true
;
_voice
?:
true
;
}
,
)
:
Promise
<
RawChannelListItem
[]
>
Parameters
params
:
{
_banners
?:
true
;
_flags
?:
true
;
_icon
?:
true
;
_limits
?:
true
;
_secondsempty
?:
true
;
_topic
?:
true
;
_voice
?:
true
;
}
= {}
Returns
Promise
<
RawChannelListItem
[]
>
channelmove
channelmove
(
params
:
{
cid
:
number
;
cpid
:
number
;
order
?:
number
}
,
)
:
Promise
<
void
>
Parameters
params
:
{
cid
:
number
;
cpid
:
number
;
order
?:
number
}
Returns
Promise
<
void
>
channelpermlist
channelpermlist
(
params
:
{
_permsid
?:
true
;
cid
:
number
}
,
)
:
Promise
<
RawChannelPermission
|
RawChannelPermission
[]
>
Parameters
params
:
{
_permsid
?:
true
;
cid
:
number
}
Returns
Promise
<
RawChannelPermission
|
RawChannelPermission
[]
>
clientaddperm
clientaddperm
()
:
void
Returns
void
clientdbdelete
clientdbdelete
(
params
:
{
cldbid
:
number
}
)
:
Promise
<
void
>
Parameters
params
:
{
cldbid
:
number
}
Returns
Promise
<
void
>
clientdbedit
clientdbedit
()
:
void
Returns
void
clientdbfind
clientdbfind
(
params
:
{
_uid
?:
true
;
pattern
:
string
}
,
)
:
Promise
<
RawClientFindDatabaseItem
|
RawClientFindDatabaseItem
[]
>
Parameters
params
:
{
_uid
?:
true
;
pattern
:
string
}
Returns
Promise
<
RawClientFindDatabaseItem
|
RawClientFindDatabaseItem
[]
>
clientdbinfo
clientdbinfo
(
params
:
{
cldbid
:
number
}
)
:
Promise
<
RawClientDbInfo
>
Parameters
params
:
{
cldbid
:
number
}
Returns
Promise
<
RawClientDbInfo
>
clientdblist
clientdblist
(
params
:
{
_count
?:
true
;
duration
?:
number
;
start
?:
number
}
,
)
:
Promise
<
RawDbClient
|
RawDbClient
[]
>
Parameters
params
:
{
_count
?:
true
;
duration
?:
number
;
start
?:
number
}
Returns
Promise
<
RawDbClient
|
RawDbClient
[]
>
clientdelperm
clientdelperm
()
:
void
Returns
void
clientedit
clientedit
(
params
:
{
clid
:
number
;
client_description
?:
string
;
client_icon_id
?:
number
;
client_is_channel_commander
?:
boolean
;
client_is_talker
?:
boolean
;
client_nickname
?:
string
;
}
,
)
:
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
>
clientfind
clientfind
(
params
:
{
pattern
:
string
}
,
)
:
Promise
<
RawClientFindItem
|
RawClientFindItem
[]
>
Parameters
params
:
{
pattern
:
string
}
Returns
Promise
<
RawClientFindItem
|
RawClientFindItem
[]
>
clientgetdbidfromuid
clientgetdbidfromuid
(
params
:
{
cluid
:
string
}
)
:
Promise
<
RawClientDbid
>
Parameters
params
:
{
cluid
:
string
}
Returns
Promise
<
RawClientDbid
>
clientgetids
clientgetids
(
params
:
{
cluid
:
string
}
,
)
:
Promise
<
RawClientIdsItem
|
RawClientIds
>
Parameters
params
:
{
cluid
:
string
}
Returns
Promise
<
RawClientIdsItem
|
RawClientIds
>
clientgetnamefromdbid
clientgetnamefromdbid
(
params
:
{
cldbid
:
number
}
)
:
Promise
<
RawClientName
>
Parameters
params
:
{
cldbid
:
number
}
Returns
Promise
<
RawClientName
>
clientgetnamefromuid
clientgetnamefromuid
(
params
:
{
cluid
:
string
}
)
:
Promise
<
RawClientName
>
Parameters
params
:
{
cluid
:
string
}
Returns
Promise
<
RawClientName
>
clientgetuidfromclid
clientgetuidfromclid
(
params
:
{
clid
:
number
}
,
)
:
Promise
<
RawClientUid
|
RawClientUid
[]
>
Parameters
params
:
{
clid
:
number
}
Returns
Promise
<
RawClientUid
|
RawClientUid
[]
>
clientinfo
clientinfo
(
params
:
{
clid
:
number
}
)
:
Promise
<
RawClient
>
Parameters
params
:
{
clid
:
number
}
Returns
Promise
<
RawClient
>
clientkick
clientkick
(
params
:
{
_continueonerror
?:
true
;
clid
:
number
;
reasonid
:
number
;
reasonmsg
?:
string
;
}
,
)
:
Promise
<
void
>
Parameters
params
:
{
_continueonerror
?:
true
;
clid
:
number
;
reasonid
:
number
;
reasonmsg
?:
string
}
Returns
Promise
<
void
>
clientlist
clientlist
(
params
?:
{
_away
?:
true
;
_badges
?:
true
;
_country
?:
true
;
_groups
?:
true
;
_icon
?:
true
;
_info
?:
true
;
_ip
?:
true
;
_times
?:
true
;
_uid
?:
true
;
_voice
?:
true
;
}
,
)
:
Promise
<
RawClient
|
RawClient
[]
>
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
[]
>
clientmove
clientmove
(
params
:
{
_continueonerror
?:
true
;
cid
:
number
;
clid
:
number
;
cpw
?:
string
;
}
,
)
:
Promise
<
void
>
Parameters
params
:
{
_continueonerror
?:
true
;
cid
:
number
;
clid
:
number
;
cpw
?:
string
}
Returns
Promise
<
void
>
clientpermlist
clientpermlist
(
params
:
{
_permsid
?:
true
;
cldbid
:
number
}
,
)
:
Promise
<
RawClientPermission
|
RawClientPermission
[]
>
Parameters
params
:
{
_permsid
?:
true
;
cldbid
:
number
}
Returns
Promise
<
RawClientPermission
|
RawClientPermission
[]
>
clientpoke
clientpoke
(
params
:
{
clid
:
number
;
msg
:
string
}
)
:
Promise
<
void
>
Parameters
params
:
{
clid
:
number
;
msg
:
string
}
Returns
Promise
<
void
>
clientsetserverquerylogin
clientsetserverquerylogin
(
params
:
{
client_login_name
:
string
}
,
)
:
Promise
<
{
client_login_password
:
string
}
>
Parameters
params
:
{
client_login_name
:
string
}
Returns
Promise
<
{
client_login_password
:
string
}
>
clientupdate
clientupdate
(
params
:
{
client_nickname
?:
string
}
)
:
Promise
<
void
>
Parameters
params
:
{
client_nickname
?:
string
}
Returns
Promise
<
void
>
complainadd
complainadd
(
params
:
{
message
:
string
;
tcldbid
:
number
}
)
:
Promise
<
void
>
Parameters
params
:
{
message
:
string
;
tcldbid
:
number
}
Returns
Promise
<
void
>
complaindel
complaindel
(
params
:
{
fcldbid
:
number
;
tcldbid
:
number
}
)
:
Promise
<
void
>
Parameters
params
:
{
fcldbid
:
number
;
tcldbid
:
number
}
Returns
Promise
<
void
>
complaindelall
complaindelall
(
params
:
{
tcldbid
:
number
}
)
:
Promise
<
void
>
Parameters
params
:
{
tcldbid
:
number
}
Returns
Promise
<
void
>
complainlist
complainlist
(
params
?:
{
tcldbid
?:
number
}
,
)
:
Promise
<
RawComplain
|
RawComplain
[]
>
Parameters
params
:
{
tcldbid
?:
number
}
= {}
Returns
Promise
<
RawComplain
|
RawComplain
[]
>
customdelete
customdelete
()
:
void
Returns
void
custominfo
custominfo
()
:
void
Returns
void
customsearch
customsearch
()
:
void
Returns
void
customset
customset
()
:
void
Returns
void
ftcreatedir
ftcreatedir
()
:
void
Returns
void
ftdeletefile
ftdeletefile
()
:
void
Returns
void
ftgetfileinfo
ftgetfileinfo
()
:
void
Returns
void
ftgetfilelist
ftgetfilelist
()
:
void
Returns
void
ftinitdownload
ftinitdownload
()
:
void
Returns
void
ftinitupload
ftinitupload
()
:
void
Returns
void
ftlist
ftlist
()
:
void
Returns
void
ftrenamefile
ftrenamefile
()
:
void
Returns
void
ftstop
ftstop
()
:
void
Returns
void
gm
gm
(
params
:
{
msg
:
string
}
)
:
Promise
<
void
>
Parameters
params
:
{
msg
:
string
}
Returns
Promise
<
void
>
help
help
()
:
void
Returns
void
hostinfo
hostinfo
()
:
Promise
<
RawHostInfo
>
Returns
Promise
<
RawHostInfo
>
instanceedit
instanceedit
()
:
void
Returns
void
instanceinfo
instanceinfo
()
:
Promise
<
RawInstance
>
Returns
Promise
<
RawInstance
>
logadd
logadd
(
params
:
{
loglevel
:
number
;
logmsg
:
string
}
)
:
Promise
<
void
>
Parameters
params
:
{
loglevel
:
number
;
logmsg
:
string
}
Returns
Promise
<
void
>
login
login
(
params
:
{
client_login_name
:
string
;
client_login_password
:
string
}
,
)
:
Promise
<
void
>
Parameters
params
:
{
client_login_name
:
string
;
client_login_password
:
string
}
Returns
Promise
<
void
>
logout
logout
()
:
Promise
<
void
>
Returns
Promise
<
void
>
logview
logview
(
params
?:
{
begin_pos
?:
number
;
instance
?:
boolean
;
lines
?:
number
;
reverse
?:
boolean
;
}
,
)
:
Promise
<
RawLogView
|
RawLogViewItem
[]
>
Parameters
params
:
{
begin_pos
?:
number
;
instance
?:
boolean
;
lines
?:
number
;
reverse
?:
boolean
}
= {}
Returns
Promise
<
RawLogView
|
RawLogViewItem
[]
>
messageadd
messageadd
()
:
void
Returns
void
messagedel
messagedel
()
:
void
Returns
void
messageget
messageget
()
:
void
Returns
void
messagelist
messagelist
()
:
void
Returns
void
messageupdateflag
messageupdateflag
()
:
void
Returns
void
permfind
permfind
()
:
void
Returns
void
permget
permget
()
:
void
Returns
void
permidgetbyname
permidgetbyname
(
params
:
{
permsid
:
string
}
,
)
:
Promise
<
{
permid
:
string
;
permsid
:
string
}
>
Parameters
params
:
{
permsid
:
string
}
Returns
Promise
<
{
permid
:
string
;
permsid
:
string
}
>
permissionlist
permissionlist
()
:
Promise
<
RawPermission
[]
>
Returns
Promise
<
RawPermission
[]
>
permoverview
permoverview
()
:
void
Returns
void
permreset
permreset
()
:
void
Returns
void
privilegekeyadd
privilegekeyadd
(
params
:
{
customset
?:
string
;
tokendescription
?:
string
;
tokenid1
:
number
;
tokenid2
:
number
;
tokentype
:
number
;
}
,
)
:
Promise
<
{
token
:
string
}
>
Parameters
params
:
{
customset
?:
string
;
tokendescription
?:
string
;
tokenid1
:
number
;
tokenid2
:
number
;
tokentype
:
number
;
}
Returns
Promise
<
{
token
:
string
}
>
privilegekeydelete
privilegekeydelete
(
params
:
{
token
:
string
}
)
:
Promise
<
void
>
Parameters
params
:
{
token
:
string
}
Returns
Promise
<
void
>
privilegekeylist
privilegekeylist
()
:
Promise
<
RawPrivilegeKey
|
RawPrivilegeKey
[]
>
Returns
Promise
<
RawPrivilegeKey
|
RawPrivilegeKey
[]
>
privilegekeyuse
privilegekeyuse
(
params
:
{
token
:
string
}
)
:
Promise
<
void
>
Parameters
params
:
{
token
:
string
}
Returns
Promise
<
void
>
queryloginadd
queryloginadd
(
params
:
{
cldbid
:
number
;
client_login_name
:
string
}
,
)
:
Promise
<
RawQueryLoginAdd
>
Parameters
params
:
{
cldbid
:
number
;
client_login_name
:
string
}
Returns
Promise
<
RawQueryLoginAdd
>
querylogindel
querylogindel
(
params
:
{
cldbid
:
number
}
)
:
Promise
<
void
>
Parameters
params
:
{
cldbid
:
number
}
Returns
Promise
<
void
>
queryloginlist
queryloginlist
(
params
:
{
_count
?:
true
;
duration
?:
number
;
pattern
?:
string
;
start
?:
number
;
}
,
)
:
Promise
<
RawQueryLogin
|
RawQueryLogin
[]
>
Parameters
params
:
{
_count
?:
true
;
duration
?:
number
;
pattern
?:
string
;
start
?:
number
}
Returns
Promise
<
RawQueryLogin
|
RawQueryLogin
[]
>
quit
quit
()
:
void
Returns
void
register
Transport
Events
registerTransportEvents
()
:
void
Returns
void
sendtextmessage
sendtextmessage
(
params
:
{
msg
:
string
;
target
:
number
;
targetmode
:
number
}
,
)
:
Promise
<
void
>
Parameters
params
:
{
msg
:
string
;
target
:
number
;
targetmode
:
number
}
Returns
Promise
<
void
>
servercreate
servercreate
(
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
;
}
,
)
:
Promise
<
RawCreatedVirtualServer
>
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
>
serverdelete
serverdelete
(
params
:
{
sid
:
number
}
)
:
Promise
<
void
>
Parameters
params
:
{
sid
:
number
}
Returns
Promise
<
void
>
serveredit
serveredit
(
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
;
}
,
)
:
Promise
<
void
>
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
>
servergroupadd
servergroupadd
(
params
:
{
name
:
string
;
type
?:
number
}
,
)
:
Promise
<
{
sgid
:
string
}
>
Parameters
params
:
{
name
:
string
;
type
?:
number
}
Returns
Promise
<
{
sgid
:
string
}
>
servergroupaddclient
servergroupaddclient
(
params
:
{
_continueonerror
?:
true
;
cldbid
:
number
;
sgid
:
number
}
,
)
:
Promise
<
void
>
Parameters
params
:
{
_continueonerror
?:
true
;
cldbid
:
number
;
sgid
:
number
}
Returns
Promise
<
void
>
servergroupaddperm
servergroupaddperm
(
params
:
{
permid
?:
number
;
permnegated
?:
boolean
;
permsid
?:
string
;
permskip
?:
boolean
;
permvalue
?:
number
;
sgid
:
number
;
}
,
)
:
Promise
<
void
>
Parameters
params
:
{
permid
?:
number
;
permnegated
?:
boolean
;
permsid
?:
string
;
permskip
?:
boolean
;
permvalue
?:
number
;
sgid
:
number
;
}
Returns
Promise
<
void
>
servergroupautoaddperm
servergroupautoaddperm
()
:
void
Returns
void
servergroupautodelperm
servergroupautodelperm
()
:
void
Returns
void
servergroupclientlist
servergroupclientlist
(
params
:
{
_names
?:
true
;
sgid
:
number
}
,
)
:
Promise
<
RawServerGroupClientListItem
|
RawServerGroupClientListItem
[]
|
null
,
>
Parameters
params
:
{
_names
?:
true
;
sgid
:
number
}
Returns
Promise
<
RawServerGroupClientListItem
|
RawServerGroupClientListItem
[]
|
null
>
servergroupcopy
servergroupcopy
(
params
:
{
name
?:
string
;
ssgid
:
number
;
tsgid
?:
number
;
type
?:
ServerGroupType
;
}
,
)
:
Promise
<
{
sgid
:
string
}
>
Parameters
params
:
{
name
?:
string
;
ssgid
:
number
;
tsgid
?:
number
;
type
?:
ServerGroupType
}
Returns
Promise
<
{
sgid
:
string
}
>
servergroupdel
servergroupdel
(
params
:
{
force
?:
boolean
;
sgid
:
number
}
)
:
Promise
<
void
>
Parameters
params
:
{
force
?:
boolean
;
sgid
:
number
}
Returns
Promise
<
void
>
servergroupdelclient
servergroupdelclient
(
params
:
{
_continueonerror
?:
true
;
cldbid
:
number
;
sgid
:
number
}
,
)
:
Promise
<
void
>
Parameters
params
:
{
_continueonerror
?:
true
;
cldbid
:
number
;
sgid
:
number
}
Returns
Promise
<
void
>
servergroupdelperm
servergroupdelperm
(
params
:
{
_continueonerror
?:
true
;
permid
?:
number
;
permsid
?:
string
;
sgid
:
number
;
}
,
)
:
Promise
<
void
>
Parameters
params
:
{
_continueonerror
?:
true
;
permid
?:
number
;
permsid
?:
string
;
sgid
:
number
}
Returns
Promise
<
void
>
servergrouplist
servergrouplist
()
:
Promise
<
RawServerGroup
|
RawServerGroup
[]
>
Returns
Promise
<
RawServerGroup
|
RawServerGroup
[]
>
servergrouppermlist
servergrouppermlist
(
params
:
{
_continueonerror
?:
true
;
_permsid
?:
true
;
sgid
:
number
}
,
)
:
Promise
<
RawAssignedPermission
|
RawAssignedPermission
[]
>
Parameters
params
:
{
_continueonerror
?:
true
;
_permsid
?:
true
;
sgid
:
number
}
Returns
Promise
<
RawAssignedPermission
|
RawAssignedPermission
[]
>
servergrouprename
servergrouprename
(
params
:
{
name
:
string
;
sgid
:
number
}
)
:
Promise
<
void
>
Parameters
params
:
{
name
:
string
;
sgid
:
number
}
Returns
Promise
<
void
>
servergroupsbyclientid
servergroupsbyclientid
(
params
:
{
cldbid
:
number
}
,
)
:
Promise
<
RawClientServerGroup
|
RawClientServerGroup
[]
>
Parameters
params
:
{
cldbid
:
number
}
Returns
Promise
<
RawClientServerGroup
|
RawClientServerGroup
[]
>
serveridgetbyport
serveridgetbyport
(
params
:
{
virtualserver_port
:
number
}
,
)
:
Promise
<
{
server_id
:
string
}
>
Parameters
params
:
{
virtualserver_port
:
number
}
Returns
Promise
<
{
server_id
:
string
}
>
serverinfo
serverinfo
()
:
Promise
<
RawVirtualServer
>
Returns
Promise
<
RawVirtualServer
>
serverlist
serverlist
(
params
?:
{
_all
?:
true
;
_onlyoffline
?:
true
;
_short
?:
true
;
_uid
?:
true
;
}
,
)
:
Promise
<
RawVirtualServerListItem
[]
>
Parameters
params
:
{
_all
?:
true
;
_onlyoffline
?:
true
;
_short
?:
true
;
_uid
?:
true
}
= {}
Returns
Promise
<
RawVirtualServerListItem
[]
>
servernotifyregister
servernotifyregister
(
params
:
{
event
:
string
;
id
?:
number
}
)
:
Promise
<
void
>
Parameters
params
:
{
event
:
string
;
id
?:
number
}
Returns
Promise
<
void
>
servernotifyunregister
servernotifyunregister
()
:
Promise
<
void
>
Returns
Promise
<
void
>
serverprocessstop
serverprocessstop
(
params
:
{
reasonmsg
?:
string
}
)
:
Promise
<
void
>
Parameters
params
:
{
reasonmsg
?:
string
}
Returns
Promise
<
void
>
serverrequestconnectioninfo
serverrequestconnectioninfo
()
:
Promise
<
RawServerConnectionInfo
>
Returns
Promise
<
RawServerConnectionInfo
>
serversnapshotcreate
serversnapshotcreate
()
:
Promise
<
RawServerSnapshot
>
Returns
Promise
<
RawServerSnapshot
>
serversnapshotdeploy
serversnapshotdeploy
(
params
:
{
_keepfiles
?:
true
;
_mapping
?:
true
;
data
:
string
;
password
?:
string
;
salt
?:
string
;
version
:
number
;
}
,
)
:
Promise
<
unknown
>
Parameters
params
:
{
_keepfiles
?:
true
;
_mapping
?:
true
;
data
:
string
;
password
?:
string
;
salt
?:
string
;
version
:
number
;
}
Returns
Promise
<
unknown
>
serverstart
serverstart
(
params
:
{
sid
:
number
}
)
:
Promise
<
void
>
Parameters
params
:
{
sid
:
number
}
Returns
Promise
<
void
>
serverstop
serverstop
(
params
:
{
reasonmsg
?:
string
;
sid
:
number
}
)
:
Promise
<
void
>
Parameters
params
:
{
reasonmsg
?:
string
;
sid
:
number
}
Returns
Promise
<
void
>
servertemppasswordadd
servertemppasswordadd
(
params
:
{
desc
:
string
;
duration
:
number
;
pw
:
string
;
tcid
?:
string
;
tcpw
?:
string
;
}
,
)
:
Promise
<
void
>
Parameters
params
:
{
desc
:
string
;
duration
:
number
;
pw
:
string
;
tcid
?:
string
;
tcpw
?:
string
}
Returns
Promise
<
void
>
servertemppassworddel
servertemppassworddel
(
params
:
{
pw
:
string
}
)
:
Promise
<
void
>
Parameters
params
:
{
pw
:
string
}
Returns
Promise
<
void
>
servertemppasswordlist
servertemppasswordlist
()
:
Promise
<
RawServerTempPassword
|
RawServerTempPassword
[]
,
>
Returns
Promise
<
RawServerTempPassword
|
RawServerTempPassword
[]
>
setclientchannelgroup
setclientchannelgroup
(
params
:
{
cgid
:
number
;
cid
:
number
;
cldbid
:
number
}
,
)
:
Promise
<
void
>
Parameters
params
:
{
cgid
:
number
;
cid
:
number
;
cldbid
:
number
}
Returns
Promise
<
void
>
tokenadd
tokenadd
()
:
void
Returns
void
tokendelete
tokendelete
()
:
void
Returns
void
tokenlist
tokenlist
()
:
void
Returns
void
tokenuse
tokenuse
()
:
void
Returns
void
use
use
(
params
:
{
client_nickname
?:
string
;
port
?:
number
;
sid
?:
number
}
,
)
:
Promise
<
void
>
Parameters
params
:
{
client_nickname
?:
string
;
port
?:
number
;
sid
?:
number
}
Returns
Promise
<
void
>
version
version
()
:
Promise
<
RawVersion
>
Returns
Promise
<
RawVersion
>
whoami
whoami
()
:
Promise
<
RawServerQueryInfo
>
Returns
Promise
<
RawServerQueryInfo
>
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
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
register
Transport
Events
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
teamspeak.js - v1.11.0
Loading...