Agora Chat Web API Reference
Hierarchy
- Connection
Index
Constructors
constructor
Parameters
options: ConnectionParameters
Returns Connection
Properties
apiUrl
appKey
Your app key.
autoReconnectNumMax
The maximum number of reconnection. The default value is 5.
delivery
Whether to enable the receipt of delivery. - true: Enable; - (Default)false: Do not enable.
deviceId
The device ID.
Optional eventHandler
heartBeatWait
The heartbeat interval(in millisecond). By default, it is 30000 ms.
https
Whether to use HTTPS only. By default, the browser determines whether to use HTTPS only according to the domain name.
isDebug
isHttpDNS
Whether to enable DNS. - (Default)true: Enable; - false: Do not enable.
token
Login user token.
url
The URL of the specified message server. This command is used when DNS is not enabled. Usually this API is used for specific customers and need to contact account manager to get it.
useOwnUploadFun
Whether to use your own upload function, for example, when uploading images and files to your own server.
version
SDK version.
Methods
addEventHandler
Registers the listener function.
Parameters
id: string
handler: EventHandlerType
Returns void
close
Closes the connection.
Returns void
isOpened
Checks the connection status. -
true: Connected; - (Default)false: Not connected.Returns boolean
open
Logs in.
Parameters
parameters: LoginParameters
Returns Promise<LoginResult>
registerUser
Registers a user.
Parameters
params: RegisterUserParameters
Returns Promise<RegisterUserResult>
removeEventHandler
Removes the listener function.
Parameters
id: string
Returns void
renewToken
Updates token.
Parameters
agoraToken: string
Returns Promise<NewTokenResult>
send
Sends message.
Parameters
params: any
Returns Promise<SendMsgResult>
The URL of the specified REST server. This command is used when DNS is not enabled. Usually this API is used for specific customers and need to contact account manager to get it.