Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Connection

Index

Constructors

Properties

_reportInterval: number = ...
_reportLogs: boolean = false
apiUrl: string

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

appKey: string

应用唯一标识。

autoReconnectNumMax: number

最大重连次数,默认 5 次。

delivery: boolean

是否开启已送达回执。-true:开启;-(默认)false:关闭。

deviceId: string

设备 ID。

enableReportLogs: boolean = false

小程序平台是否允许上传日志。-true:开启;false:关闭 -(默认)。

eventHandler?: EventHandler
heartBeatWait: number

心跳时间间隔(单位为毫秒),默认 30000 ms。

https: boolean

是否只用 https,浏览器环境默认根据使用域名自行判断。

isDebug: boolean
isFixedDeviceId?: boolean

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

isHttpDNS: boolean

是否启用 DNS。-(默认)true:开启 DNS;- false:不开启 DNS。

name: string = 'connection'
token: string

登录用户 token。

url: string

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

useOwnUploadFun: boolean

是否使用自己的上传函数,如想把图片、文件上传到自己的服务器。

useReplacedMessageContents: boolean

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

version: string

SDK 版本。

Methods

  • 注册监听函数。

    Parameters

    Returns void

  • close(): void
  • 关闭连接。

    Returns void

  • getDNS(): Promise<void | AsyncResult<any>>
  • Returns Promise<void | AsyncResult<any>>

  • isOpened(): boolean
  • 监测连接状态。-true:已连接;- false:未连接。

    Returns boolean

  • removeEventHandler(id: string): void
  • 移除监听函数。

    Parameters

    • id: string

    Returns void

  • 更新 token。

    Parameters

    • token: string

    Returns Promise<NewTokenResult>

  • setLoginInfoCustomExt(ext: string): void
  • 设置登录信息自定义扩展。多设备登录被踢时,会将该自定义扩展信息传递给被踢设备。

    Parameters

    • ext: string

    Returns void

Generated using TypeDoc