API 参考

ccaas Web SDK 实例的接口。

属性

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

版本

Web SDK 的版本。

console.log(ccaas.VERSION)

客户端

这是 Headless 客户端的实例，其中包含 Headless 客户端上提供的所有内容。

示例如下：

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

方法

微件实例上的可用方法。

.config

更新微件的配置。

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

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

.mount

将微件装载到给定元素上。例如，在您的网页上：

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

然后，您可以使用以下代码装载 Web SDK 微件：

ccaas.mount('#my-ccaas')

.unmount

从您的网页中移除 Web SDK 微件。

ccaas.unmount()

.destroy

卸载并销毁所有内容。

ccaas.destroy()

.show

显示微件界面。

ccaas.show()

.hide

隐藏微件界面。

ccaas.hide()

.start

使用给定选项显示并启动微件。

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

示例：

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

事件

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

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

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

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

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

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

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

显示

当微件可见性发生变化（打开或关闭）时发出。

以下示例展示了 visible 事件：

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

chat.unread

当未读消息计数发生变化时发出。

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

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

已退出

当最终用户关闭微件且会话结束时发出。

以下示例展示了 exited 事件：

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