API リファレンス

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

プロパティ

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

version

ウェブ 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' })

イベント

このセクションでは、ウェブ 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
})