Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ConnectionParameters

Index

Properties

apiUrl?: string

The URL of the specified REST server. This 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.

appKey: string

The unique application key registered on the console.

autoReconnectNumMax?: number

The maximum number of reconnection attempts allowed.

delivery?: boolean

Whether to enable the delivery receipt function. - true: Enable; - (Default)false: Disable.

deviceId?: string

The unique web device ID. By default, it is a random number.

enableReportLogs?: boolean

Does the mini program platform allow uploading logs - True: enabled False: Close - (default).

heartBeatWait?: number

The heartbeat interval (in seconds). The default value is 30,000 seconds.

https?: boolean

Whether to use HTTPS only. By default, the browser determines whether to use HTTPS only according to the domain name.

isDebug?: boolean

Whether to start logging. - true: Yes; - (Default)false: No.

isFixedDeviceId?: boolean

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.

isHttpDNS?: boolean

Whether to enable DNS to prevent DNS hijacking. - (Default)true: Enable; - false: Disable.

url?: string

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.

useOwnUploadFun?: boolean

Whether to use your own upload function, for example, when uploading images and files to your server. - true: Yes. Use your own upload function; - (Default)false: No. Upload images and files to the message server.

useReplacedMessageContents?: boolean

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.

Generated using TypeDoc