接口概览
Globals
ArRTM
RtmClient
RtmChannel
LocalInvitation
RemoteInvitation
RtmEvents
RtmMessage
RtmErrorCode
RtmStatusCode

ArRTM 属性与方法

最近更新时间：2022-09-20 05:17:40

方法
createInstance

实时消息 Web SDK 暴露的全局对象 ArRTM，该对象含有该模块的所有成员。

ArRTM 包含以下属性：

属性描述
ConnectionChangeReason连接状态改变原因，详见：ConnectionChangeReason。
ConnectionStateSDK 与 anyRTC RTM 系统的连接状态，详见：ConnectionState。
LOG_FILTER_OFF不输出日志信息。
LOG_FILTER_ERROR输出 ERROR 级别的日志信息。
LOG_FILTER_WARNING输出 ERROR 和 WARNING 级别的日志信息。
LOG_FILTER_INFO输出 ERROR、WARNING 和 INFO 级别的日志信息(推荐)。
LocalInvitationFailureReason返回给主叫呼叫邀请的失败原因，详见：LocalInvitationFailureReason。
LocalInvitationState返回给主叫的呼叫邀请状态，详见：LocalInvitationState。
MessageType消息类型，详见：MessageType。
PeerOnlineState用户的在线状态，详见：PeerOnlineState。
PeerSubscriptionOption订阅类型，详见：PeerSubscriptionOption。
RemoteInvitationFailureReason返回给被叫呼叫邀请失败原因，详见：RemoteInvitationFailureReason。
RemoteInvitationState返回给被叫的呼叫邀请状态，详见：RemoteInvitationState。
VERSIONanyRTC RTM SDK 的版本号。

ArRTM 包含以下 API 方法：

API描述
createInstance创建并返回一个 RtmClient 实例，发送点对点消息、创建频道都是基于这个实例进行操作。

方法

createInstance

createInstance(appId: string, config?: RtmConfig): RtmClient

创建一个 RtmClient 实例。

anyRTC RTM SDK 支持多个 RtmClient 实例。

示例

import ArRTM from "ar-rtm-sdk";

/**
 * 创建 RTM 客户端实例
 * @params appId: 项目的 App ID。必须是 ASCII 编码，长度为 32 个字符。(类型：string)
 * @param {RtmParameters} [params]  对象的配置参数。
 */
const client = ArRTM.createInstance(appId, { enableLogUpload: false });

参数

参数类型描述
appIdstring项目的 App ID。必须是 ASCII 编码，长度为 32 个字符。
Optional RtmParametersRtmParametersRtmClient 对象的配置参数。

返回

一个 RtmClient 实例。