Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • default

Index

Constructors

constructor

  • new default(options: ConnectionParameters): default
  • Parameters

    • options: ConnectionParameters

    Returns default

Properties

apiUrl

apiUrl: string

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

appKey

appKey: string

应用唯一标识。

autoReconnectNumMax

autoReconnectNumMax: number

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

context

context: { accessToken: string; appKey: string; appName: string; jid: { appKey: string; clientResource: string; domain: string; name: string }; orgName: string; restTokenData: string; root: any; status: number; userId: string }

Type declaration

  • accessToken: string
  • appKey: string
  • appName: string
  • jid: { appKey: string; clientResource: string; domain: string; name: string }
    • appKey: string
    • clientResource: string
    • domain: string
    • name: string
  • orgName: string
  • restTokenData: string
  • root: any
  • status: number
  • userId: string

delivery

delivery: boolean

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

deviceId

deviceId: string

设备 ID。

Optional eventHandler

eventHandler?: default

grantType

grantType: "" | "password" | "accessToken" | "agoraToken"

heartBeatWait

heartBeatWait: number

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

https

https: boolean

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

isDebug

isDebug: boolean

isHttpDNS

isHttpDNS: boolean

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

isReport

isReport: boolean

token

token: string

登录用户 token。

url

url: string

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

useOwnUploadFun

useOwnUploadFun: boolean

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

version

version: string

SDK 版本。

Methods

addEventHandler

  • 注册监听函数。

    Parameters

    Returns void

close

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

    Returns void

isOpened

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

    Returns boolean

listen

  • 注册监听函数。

    deprecated

    Parameters

    Returns void

open

  • open(parameters: LoginParameters): Promise<LoginResult>
  • 登录。

    Parameters

    • parameters: LoginParameters

    Returns Promise<LoginResult>

registerUser

  • registerUser(params: RegisterUserParameters): Promise<RegisterUserResult>
  • 注册用户。

    Parameters

    • params: RegisterUserParameters

    Returns Promise<RegisterUserResult>

removeEventHandler

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

    Parameters

    • id: string

    Returns void

renewToken

  • renewToken(agoraToken: string): Promise<object>
  • 更新 token。

    Parameters

    • agoraToken: string

    Returns Promise<object>

send

  • 发送消息。

    Parameters

    • params: any

    Returns Promise<SendMsgResult>

Generated using TypeDoc