跳到主要内容

InfiAccessorySDK API 说明

更新时间 2024/12/02 01:54:56

InfiAccessorySDK 全局对象是使用英飞辅助 SDK 因为的功能入口。

获取方式​

在引入 CDN 脚本文件后， 您可以通过访问我们挂载在 window 上的InfiAccessorySDK 属性来获取到辅助 SDK 全局对象示例。

const sdk = window.InfiAccessorySDK;

API 列表​

createClient​

createClient: (config: AccessoryClientConfigT) => Promise<CreateClientType>;

初始化辅助 SDK 客户端实例，并加入指定业务频道。客户端实例可用于执行具体业务，API 可参考文档。

参数​

AccessoryClientConfigT 对象类型属性说明如下：

参数名
类型
描述
token
string
初始化辅助 SDK 所需要的鉴权 Token，生成方式请参考文档
channelId
string
业务频道 ID
loginName
string
用户 ID

返回​

执行 createClient API 后，您会获取到一个 Promise 对象 (CreateClientType)， 该对象在 fulfill 后，会有以下可能的返回结果：

  • 执行成功，返回对象为:

    {
      code: 0; // 成功状态码
      payload: InfiAccessoryClient; // 辅助 SDK 客户端实例对象
    }

  • 执行失败，返回对象为:

    {
      code: number; // 失败错误码
    }

    错误码对应含义可以参考错误码文档。

setLogLevel​

setLogLevel: (level: LogLevel | 0) => void;

设置辅助 SDK 日志输出模式，日志输出默认处于关闭状态。日志会在浏览器 console 内体现。

参数​

LogLevel 为数字类型，支持以下设置：

  • 1：DEBUG 级别，会输出包括 DEBUG、INFO、WARN、ERROR 全部的日志信息。
  • 2：INFO 级别，会输出包括 INFO、WARN、ERROR 级别的日志信息。
  • 3：WARN 级别，会输出包括 WARN、ERROR 级别的日志信息。
  • 4：ERROR 级别，会输出包括 ERROR 级别的日志信息。

如果入参给入 0，则会关闭日志输出功能。

属性列表​

VERSION​

获取当前 Web SDK 的版本信息。