API 参考

ccaas Web SDK 实例的接口。

属性

本部分包含您可能会用到的一些属性。

版本

Web SDK 的版本。

console.log(ccaas.VERSION)

客户端

这是无头客户端的实例，包含无头客户端上可用的所有内容。

示例如下：

const client = ccaas.client
const chat = await client.loadOngoingChat()

方法

widget 实例上的可用方法。

.config

更新 widget 的配置。

ccaas.config({
  accent: 'green'
})

如需了解详情，请参阅配置部分。

.mount

将 widget 挂载到指定元素上。例如，在您的网页上：

<div id="my-ccaas"></div>

然后，您可以使用以下命令挂载 Web SDK widget：

ccaas.mount('#my-ccaas')

.unmount

从网页中移除 Web SDK widget。

ccaas.unmount()

.destroy

卸载并销毁所有内容。

ccaas.destroy()

.show

显示 widget 界面。

ccaas.show()

.hide

隐藏 widget 界面。

ccaas.hide()

.start

显示并启动具有指定选项的小部件。

interface StartOption {
  menuKey?: string;
  ticketId?: string;
  preferredChannel?: string;
}

示例：

ccaas.start({ menuKey: 'vip' })

事件

本部分介绍了 Web SDK 中提供的事件。如需查看无头 Web SDK 中提供的事件的完整列表，请参阅无头 Web SDK 事件。

使用 .on 方法添加事件监听器。请参阅以下示例：

const trackChat = (chat) => {
  console.log(chat)
}

ccaas.on('chat.updated', trackChat)

使用 .off 方法移除事件监听器。请参阅以下示例：

ccaas.off('chat.updated', trackChat)

.on 和 .off 方法是无头 Web SDK 的 .on 和 .off 方法的别名。如需了解详情，请参阅无头 Web SDK 指南。

显示

当 widget 准备好进行通信时，系统会发出 visible 事件。

以下示例展示了 visible 事件：

ccaas.on('visible', (visible) => {
  console.log(visible)  // true or false
})

chat.unread

未读消息数量发生变化时，系统会发出 chat.unread 事件。

以下示例展示了 chat.unread 事件：

ccaas.on('chat.unread', (count) => {
  console.log(count)
})

已退出

当最终用户关闭 widget 时，系统会发出 exited 事件。

以下示例展示了 exited 事件：

ccaas.on('exited', () => {
  // widget was exited
})