Your App Key.
The maximum number of reconnection attempts allowed. The default value is 5
.
Whether to enable the receipt of delivery. - true
: Enable; - (Default)false
: Disable.
The device ID.
Does the mini program platform allow uploading logs - True
: enabled False
: Close - (default).
The heartbeat interval (in millisecond). By default, it is 30000 ms.
Whether to use HTTPS only. By default, the browser determines whether to use HTTPS only according to the domain name.
Whether to use a fixed device ID (deviceId).
- (Default) true
: The SDK generates a device ID for a browser and saves it to the local storage. Then in the browser, all SDK instances use the same device.
-false
: A random device ID is used for connections of each SDK instance. That is to say, each SDK instance uses a different device for connections.
This parameter has an impact on the kicking policy during a multi-device login scenario.
Whether to enable DNS. - (Default)true
: Enable; - false
: Disable.
The user token for login.
The URL of the specified message server. Usually, this URL is used by specific customers who expects to implement data isolation for strict data security. To get the URL, contact our account manager.
Whether to use your own upload function, for example, when uploading images and files to your own server.
When the moderation service replaces the content of a message, whether the adjusted message is returned to the sender. - true
: Return the adjusted message to the sender. - false
: Return the original message to the sender.
The SDK version.
Registers the listener function.
Closes the connection.
Download and parse the merged message.
Checks the connection status. - true
: Connected; - (Default)false
: Disconnected.
Logs in.
Registers a user.
Removes the listener function.
Updates the token.
Sends message.
Set custom extensions for login information. When a multi-device login is kicked, the custom extension information will be passed to the kicked device.
Generated using TypeDoc
The URL of the specified REST server. The URL is used when DNS is not enabled. Usually, this URL is used by specific customers who expects to implement data isolation for strict data security. To get the URL, contact our account manager.