この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

onCustomEvent()

チャット中にカスタムイベントが実行されるとコールされる関数を登録します。API バージョン 29.0 以降で使用できます。

構文

1sforce.console.chat.onCustomEvent(chatKey:String, type:String, callback:Function)

引数

名前	型	説明
chatKey	String	カスタムイベントが実行されると関数をコールするチャットに関連付けられた `chatKey`。
type	String	リスンするカスタムイベントの名前。これは、チャットウィンドウから送信されたカスタムイベントの名前と一致します。
callback	function	メソッドの完了時にコールされる JavaScript メソッド。

サンプルコード – Visualforce

1<apex:page >
2    <apex:includeScript value="/support/console/56.0/integration.js"/>
3    <script type="text/javascript">
4        var eventHandler = function (result) {
5            alert('A new custom event has been received of type ' + result.type + ' and with data: ' + result.data );
6        }
7        //Get the value for 'myChatKey' from the sforce.console.chat.getDetailsByPrimaryTabId() or other chat methods. 
8        //These values are for example purposes only
9        var chatKey = 'myChatKey';
10        var type = 'myCustomEventType';
11        sforce.console.chat.onCustomEvent(chatKey, type, eventHandler);
12    </script>
13</apex:page>

応答

このメソッドは非同期であるため、コールバックメソッドのオブジェクトで応答を返します。応答オブジェクトには次のプロパティが含まれます。

名前	型	説明
type	String	このチャットに送信されたカスタムイベントのタイプ。チャットウィンドウからこのイベントを送信するために使用された `liveagent.chasitor.sendCustomEvent()` メソッドの `type` 引数に対応します。
data	String	このチャットに送信されたカスタムイベントのデータ。チャットウィンドウからこのイベントを送信するために使用された `liveagent.chasitor.sendCustomEvent()` メソッドの `data` 引数に対応します。
source	String	このチャットに送信されたカスタムイベントの発生元。カスタムイベントをトリガしたエージェントまたはチャット訪問者に対応します。
timestamp	Date/Time	イベントの受信日時。
success	Boolean	イベントが正常に起動された場合は `true`、イベントが正常に起動されなかった場合は `false`。

Salesforce コンソール開発者ガイド

onCustomEvent()

構文

引数

サンプルコード – Visualforce

応答