chasitor.getCustomEvents()
このチャットセッション中にこのチャットウィンドウで受信されたカスタムイベントのリストを取得します。API バージョン 29.0 以降で使用できます。
構文
1liveagent.chasitor.getCustomEvents()サンプルコード – Visualforce
1<a href="#" onClick="testGetCustomEvents();">Get Custom Events</a>
2
3<script type="text/javascript">
4 function testGetCustomEvents() {
5 events = liveagent.chasitor.getCustomEvents();
6 eventsCount = events.length;
7 alert('The following number of custom events have occurred: ' + eventsCount);
8 };
9</script>応答
このメソッドは非同期であるため、コールバックメソッドのオブジェクトで応答を返します。応答オブジェクトには次のメソッドとプロパティが含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| events | event オブジェクトの配列 |
event オブジェクトの配列。各オブジェクトは、このチャットで発生したカスタムイベントを表します。各メッセージオブジェクトのデータには、次のメソッドによりアクセスできます。
|
| getType | method | このチャットウィンドウに送信されたカスタムイベントのタイプにアクセスします。このイベントの送信に使用される sforce.console.chat.sendCustomEvent() メソッドの type 引数を返します。 |
| getData | method | このチャットウィンドウに送信されたカスタムイベントのデータにアクセスします。このイベントの送信に使用される sforce.console.chat.sendCustomEvent() メソッドの data 引数を返します。 |
| getSource | method | このチャットウィンドウに送信されたカスタムイベントの発生元 (エージェントまたはチャット訪問者など) にアクセスします。 |
| getDate | method | このチャットウィンドウに送信されたカスタムイベントの日付にアクセスします。イベントが受信された日時を返します。 |