Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Connection

Index

Constructors

Properties

apiUrl: string

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

appKey: string

应用唯一标识。

autoReconnectNumMax: number

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

dataReport: DataReport
delivery: boolean

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

deviceId: string

设备 ID。

eventHandler?: EventHandler
heartBeatWait: number

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

https: boolean

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

isDebug: boolean
isHttpDNS: boolean

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

name: string = 'connection'
token: string

登录用户 token。

url: string

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

useOwnUploadFun: boolean

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

version: string

SDK 版本。

Methods

  • 注册监听函数。

    Parameters

    Returns void

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

    Returns void

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

    Returns boolean

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

    Parameters

    • id: string

    Returns void

  • 更新 token。

    Parameters

    • agoraToken: string

    Returns Promise<NewTokenResult>

Generated using TypeDoc