API 參考資料

ccaas Web SDK 執行個體的介面。

屬性

本節包含您可能會使用的一些屬性。

版本

Web SDK 版本。

console.log(ccaas.VERSION)

用戶端

這是 無頭用戶端的例項，包含無頭用戶端的所有可用項目。

範例如下：

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

方法

小工具例項可用的方法。

.config

更新小工具設定。

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

詳情請參閱「設定」一節。

.mount

將小工具掛載在指定元素上。舉例來說，在網頁上：

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

接著，您可以使用下列指令掛接網頁 SDK 小工具：

ccaas.mount('#my-ccaas')

.unmount

從網頁中移除 Web SDK 小工具。

ccaas.unmount()

.destroy

卸載並銷毀所有項目。

ccaas.destroy()

.show

顯示小工具 UI。

ccaas.show()

.hide

隱藏小工具 UI。

ccaas.hide()

.start

使用指定選項顯示及啟動小工具。

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

範例：

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

活動

本節說明 Web SDK 中提供的事件。如需無頭網頁 SDK 中可用事件的完整清單，請參閱「無頭網頁 SDK 事件」。

使用 .on 方法新增事件監聽器。請參閱以下範例：

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

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

使用 .off 方法移除事件監聽器。請參閱以下範例：

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

.on 和 .off 方法是無頭網頁 SDK 的 .on 和 .off 方法別名。詳情請參閱無頭網頁 SDK 指南。

顯示

當小工具準備好通訊時，系統會發出 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)
})

已退出

使用者關閉小工具時，系統會發出 exited 事件。

以下範例顯示 exited 事件：

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