实时消息 Web SDK 暴露的全局对象 ArTalk
,该对象含有该模块的所有成员。
ArTalk 包含以下属性:
属性 | 描述 |
---|---|
LOG_FILTER_OFF | 不输出日志信息。 |
LOG_FILTER_ERROR | 输出 ERROR 级别的日志信息。 |
LOG_FILTER_WARNING | 输出 ERROR 和 WARNING 级别的日志信息。 |
LOG_FILTER_INFO | 输出 ERROR、WARNING 和 INFO 级别的日志信息(推荐)。 |
VERSION | anyRTC Talk SDK 的版本号。 |
ArTalk 包含以下 API 方法:
API | 描述 |
---|---|
createInstance | 创建并返回一个 TalkClient 实例,即创建客户端实例,很多操作都是基于客户端去实现的。 |
方法
createInstance
createInstance(appId: string, params?: TalkParameters): TalkClient
创建一个 TalkClient 实例。
anyRTC Talk SDK 支持多个 TalkClient 实例。
示例
import ArTalk from "ar-talk-sdk";
/**
* 创建 Talk 客户端实例
* @params appId: 项目的 App ID。必须是 ASCII 编码,长度为 32 个字符。(类型:string)
* @param {TalkParameters} [params] 对象的配置参数。
*/
const client = ArTalk.createInstance(appId);
参数
参数 | 类型 | 描述 |
---|---|---|
appId | string | 项目的 App ID。必须是 ASCII 编码,长度为 32 个字符。 |
Optional TalkParameters | TalkParameters | TalkClient 对象的配置参数。 |
返回
一个 TalkClient 实例。