ConversationalAIAPI 类

getInstance

JavaScript

public static getInstance()

获取 ConversationalAIAPI 的单例实例。

信息

自 1.6.0 版本新增。

调用该方法前必须先调用 initialize 进行初始化。如果未初始化，将抛出 NotFoundError 异常。

返回值

方法调用成功，返回 ConversationalAIAPI 实例。如果未初始化，抛出 NotFoundError 异常。

init

JavaScript

public static init(cfg: IConversationalAIAPIConfig)

初始化 ConversationalAIAPI 单例实例。

信息

自 1.6.0 版本新增。

该方法用于设置 RTC 和 RTM 引擎、渲染模式以及日志选项。必须在调用 ConversationalAIAPI 的其他方法之前调用此方法。

• 同一时间只能初始化一个实例。
• 如果已初始化，将抛出错误。

参数

参数	数据类型	描述
cfg	IConversationalAIAPIConfig	用于初始化 API 的配置对象，详见 IConversationalAIAPIConfig。

返回值

方法调用成功，返回 ConversationalAIAPI 实例。

subscribeMessage

JavaScript

public subscribeMessage(channel: string)

订阅消息频道以获取实时更新。

信息

自 1.6.0 版本新增。

该方法绑定必要的 RTC 和 RTM 事件，并启动 CovSubRenderController 以处理接收到的消息。

注意

• 使用此方法前必须调用 initialize。
• 如果未初始化将抛出错误。

参数

参数	数据类型	描述
channel	string	要订阅消息的频道。

unsubscribe

JavaScript

public unsubscribe()

取消订阅消息频道并清理资源。

信息

自 v1.6.0 版本新增。

该方法会解绑 RTC 和 RTM 事件，清空频道，并清理 CovSubRenderController。调用该方法前必须先调用 subscribeMessage 进行初始化，否则会抛出错误。

destroy

JavaScript

public destroy()

销毁 ConversationalAIAPI 实例并清理资源。

信息

自 v1.6.0 版本新增。

注意

• 在调用该方法前，必须先调用 unsubscribe。
• 如果未初始化则会抛出错误。

interrupt

JavaScript

public async interrupt(agentUserId: string)

向指定的代理用户发送中断消息。

信息

自 1.6.0 版本新增。

注意

如果未初始化或发送失败，将抛出错误。

参数

参数	数据类型	描述
agentUserId	string	要中断的代理用户的用户 ID。