Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Connection

The connection module is responsible for creating a persistent connection between the SDK and the chat server. This module involves all APIs for login, contacts, groups, and chat rooms.

Index

Classes

Interfaces

Type Aliases

Type Aliases

ConnectionParameters

ConnectionParameters: { apiUrl?: string; appId?: string; appKey?: string; autoReconnectNumMax?: number; delivery?: boolean; deviceId?: string; heartBeatWait?: number; https?: boolean; isDebug?: boolean; isFixedDeviceId?: boolean; isHttpDNS?: boolean; url?: string; useOwnUploadFun?: boolean; useReplacedMessageContents?: boolean }

Type declaration

  • Optional apiUrl?: string

    指定的 REST server。在没有开启 DNS 的情况下使用。一般在开发者想实现数据隔离、特别注重数据安全时使用，如有需求请联系商务获取指定的服务器地址。

  • Optional appId?: string

    在管理后台注册的应用唯一 id

  • Optional appKey?: string

    在管理后台注册的应用唯一 key。

  • Optional autoReconnectNumMax?: number

    最大重连次数。

  • Optional delivery?: boolean

    是否开启已送达回执。-true：开启；-（默认）false：关闭。

  • Optional deviceId?: string

    设备 ID，默认随机值。

  • Optional heartBeatWait?: number

    心跳间隔（单位为毫秒），默认 30000ms。

  • Optional https?: boolean

    是否指定为 HTTPS，浏览器环境默认根据使用域名自行判断。

  • Optional isDebug?: boolean

    是否开始日志。

  • Optional isFixedDeviceId?: boolean

    是否使用固定的设备标识（deviceId）。
    -（默认）true：SDK 对设备生成一个设备标识并存入本地存储，即对一个浏览器来说，所有 SDK 实例的连接都被认为是同一设备。
    - false：每一个 SDK 实例连接时，使用随机字符串作为设备标识，即每个实例采用的不同的设备连接。
    该参数会影响多端登录互踢的策略。

  • Optional isHttpDNS?: boolean

    是否开启 DNS，防止 DNS 劫持。
    -（默认）true：开启 DNS；
    - false：不开启 DNS。

  • Optional url?: string

    指定的消息服务器。在没有开启 DNS 的情况下使用。一般在开发者想实现数据隔离、特别注重数据安全时使用，如有需求请联系商务获取指定的服务器地址。

  • Optional useOwnUploadFun?: boolean

    是否使用自己的上传函数，如想把图片、文件上传到自己的服务器。-true：开启，需要自己指定路径；-（默认）false：关闭，用消息服务器上传下载文件。

  • Optional useReplacedMessageContents?: boolean

    当发送的消息内容被审核服务替换时，是否需要返回给发送方。true：将内容替换后的消息返回给发送方。false：将原消息返回给发送方。

Generated using TypeDoc