onNewMessage()
顧客、エージェント、またはスーパーバイザから新しいメッセージが送信されるとコールされる関数を登録します。API バージョン 29.0 以降で使用できます。
構文
1sforce.console.chat.onNewMessage(chatKey:String, callback:Function)引数
| 名前 | 型 | 説明 |
|---|---|---|
| chatKey | string | 新しい顧客メッセージを受信すると関数をコールするチャットに関連付けられた chatKey。 |
| callback | function | メソッドの完了時にコールされる JavaScript メソッド。 |
サンプルコード – Visualforce
1<apex:page >
2 <apex:includeScript value="/support/console/41.0/integration.js"/>
3 <script type="text/javascript">
4 var eventHandler = function (result) {
5 alert('There is a new message in this chat: ' + result.content);
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 sforce.console.chat.onNewMessage(chatKey, eventHandler);
11 </script>
12</apex:page>応答
このメソッドは非同期であるため、コールバックメソッドのオブジェクトで応答を返します。応答オブジェクトには次のプロパティが含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| content | String | チャットログのメッセージのテキスト。 |
| name | String | メッセージを送信したユーザの名前。これは、チャットログとまったく同じように表示されます。 |
| type | String | 受信メッセージの種別 (エージェントメッセージや訪問者メッセージなど)。 |
| timestamp | Date/Time | メッセージの受信日時。 |
| success | Boolean | イベントが正常に起動された場合は true、イベントが正常に起動されなかった場合は false。 |