ChatClient
Defined in: chat.ts:32
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ChatClient(
botToken,options?):ChatClient
Defined in: chat.ts:44
Parameters
Section titled “Parameters”botToken
Section titled “botToken”string
options?
Section titled “options?”Returns
Section titled “Returns”ChatClient
Accessors
Section titled “Accessors”connectedChannels
Section titled “connectedChannels”Get Signature
Section titled “Get Signature”get connectedChannels():
string[]
Defined in: chat.ts:448
Returns
Section titled “Returns”string[]
currentChannel
Section titled “currentChannel”Get Signature
Section titled “Get Signature”get currentChannel():
string|null
Defined in: chat.ts:459
Returns
Section titled “Returns”string | null
isConnected
Section titled “isConnected”Get Signature
Section titled “Get Signature”get isConnected():
boolean
Defined in: chat.ts:452
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”banUser()
Section titled “banUser()”banUser(
channelName,targetUserId,targetUsername,reason?):void
Defined in: chat.ts:288
Parameters
Section titled “Parameters”channelName
Section titled “channelName”string
targetUserId
Section titled “targetUserId”string
targetUsername
Section titled “targetUsername”string
reason?
Section titled “reason?”string
Returns
Section titled “Returns”void
connect()
Section titled “connect()”connect(
channelName):Promise<void>
Defined in: chat.ts:49
Parameters
Section titled “Parameters”channelName
Section titled “channelName”string
Returns
Section titled “Returns”Promise<void>
disconnect()
Section titled “disconnect()”disconnect(
channelName?):void
Defined in: chat.ts:226
Parameters
Section titled “Parameters”channelName?
Section titled “channelName?”string
Returns
Section titled “Returns”void
isConnectedTo()
Section titled “isConnectedTo()”isConnectedTo(
channelName):boolean
Defined in: chat.ts:443
Parameters
Section titled “Parameters”channelName
Section titled “channelName”string
Returns
Section titled “Returns”boolean
liftTimeout()
Section titled “liftTimeout()”liftTimeout(
channelName,targetUserId,targetUsername):void
Defined in: chat.ts:305
Parameters
Section titled “Parameters”channelName
Section titled “channelName”string
targetUserId
Section titled “targetUserId”string
targetUsername
Section titled “targetUsername”string
Returns
Section titled “Returns”void
onChatAccess()
Section titled “onChatAccess()”onChatAccess(
handler,channelName?): () =>void
Defined in: chat.ts:392
Parameters
Section titled “Parameters”handler
Section titled “handler”channelName?
Section titled “channelName?”string
Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void
onHistory()
Section titled “onHistory()”onHistory(
handler,channelName?): () =>void
Defined in: chat.ts:348
Parameters
Section titled “Parameters”handler
Section titled “handler”channelName?
Section titled “channelName?”string
Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void
onMessage()
Section titled “onMessage()”onMessage(
handler,channelName?): () =>void
Defined in: chat.ts:316
Parameters
Section titled “Parameters”handler
Section titled “handler”channelName?
Section titled “channelName?”string
Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void
onModerationError()
Section titled “onModerationError()”onModerationError(
handler,channelName?): () =>void
Defined in: chat.ts:364
Parameters
Section titled “Parameters”handler
Section titled “handler”channelName?
Section titled “channelName?”string
Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void
onModerationEvent()
Section titled “onModerationEvent()”onModerationEvent(
handler,channelName?): () =>void
Defined in: chat.ts:378
Parameters
Section titled “Parameters”handler
Section titled “handler”channelName?
Section titled “channelName?”string
Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void
onSystemMessage()
Section titled “onSystemMessage()”onSystemMessage(
handler,channelName?): () =>void
Defined in: chat.ts:332
Parameters
Section titled “Parameters”handler
Section titled “handler”channelName?
Section titled “channelName?”string
Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void
sendMessage()
Section titled “sendMessage()”sendMessage(
message,channelName?):void
Defined in: chat.ts:245
Parameters
Section titled “Parameters”message
Section titled “message”string
channelName?
Section titled “channelName?”string
Returns
Section titled “Returns”void
sendModerationCommand()
Section titled “sendModerationCommand()”sendModerationCommand(
command,channelName):void
Defined in: chat.ts:263
Parameters
Section titled “Parameters”command
Section titled “command”channelName
Section titled “channelName”string
Returns
Section titled “Returns”void
timeoutUser()
Section titled “timeoutUser()”timeoutUser(
channelName,targetUserId,targetUsername,durationSeconds):void
Defined in: chat.ts:271
Parameters
Section titled “Parameters”channelName
Section titled “channelName”string
targetUserId
Section titled “targetUserId”string
targetUsername
Section titled “targetUsername”string
durationSeconds
Section titled “durationSeconds”number = 300
Returns
Section titled “Returns”void