API リファレンス

ccaas ウェブ SDK インスタンスのインターフェース。

プロパティ

このセクションでは、使用できるプロパティの一部について説明します。

version

ウェブ 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>

ウェブ SDK ウィジェットは次のようにマウントできます。

ccaas.mount('#my-ccaas')

.unmount

ウェブページからウェブ 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' })

イベント

このセクションでは、ウェブ SDK で使用できるイベントについて説明します。Headless ウェブ SDK で使用できるイベントの完全なリストについては、Headless ウェブ SDK イベントをご覧ください。

.on メソッドを使用してイベント リスナーを追加します。次の例をご覧ください。

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

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

.off メソッドを使用してイベント リスナーを削除します。次の例をご覧ください。

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

.on メソッドと .off メソッドは、Headless ウェブ SDK の .on メソッドと .off メソッドのエイリアスです。詳細については、Headless ウェブ 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

エンドユーザーがウィジェットを閉じてセッションが終了したときに発行されます。

次の例は、exited イベントを示しています。

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