ChatClient
Defined in: chat.ts:22
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ChatClient(
botToken,options?):ChatClient
Defined in: chat.ts:31
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:273
Returns
Section titled “Returns”string[]
currentChannel
Section titled “currentChannel”Get Signature
Section titled “Get Signature”get currentChannel():
string|null
Defined in: chat.ts:284
Returns
Section titled “Returns”string | null
isConnected
Section titled “isConnected”Get Signature
Section titled “Get Signature”get isConnected():
boolean
Defined in: chat.ts:277
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”connect()
Section titled “connect()”connect(
channelName):Promise<void>
Defined in: chat.ts:36
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:169
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:268
Parameters
Section titled “Parameters”channelName
Section titled “channelName”string
Returns
Section titled “Returns”boolean
onHistory()
Section titled “onHistory()”onHistory(
handler,channelName?): () =>void
Defined in: chat.ts:238
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:206
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:222
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:188
Parameters
Section titled “Parameters”message
Section titled “message”string
channelName?
Section titled “channelName?”string
Returns
Section titled “Returns”void