onAgentSend()
エージェントが Salesforce コンソールでチャットメッセージを送信するとコールされる関数を登録します。このメソッドにより、メッセージが受信されます。また、このメソッドはメッセージがチャット訪問者に送信される前に発生します。API バージョン 29.0 以降で使用できます。
構文
1sforce.console.chat.onAgentSend(chatKey:String, callback:Function)引数
| 名前 | 型 | 説明 |
|---|---|---|
| chatKey | String | チャットでエージェントがメッセージを送信すると関数をコールする場合に、そのチャットに関連付けられた chatKey。 |
| callback | function | メソッドの完了時にコールされる JavaScript メソッド。 |
サンプルコード – Visualforce
1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17<apex:page >
18 <apex:includeScript value="/support/console/29.0/integration.js"/>
19 <script type="text/javascript">
20 var eventHandler = function (result) {
21 var theMessage = result.content;
22 alert('The agent is attempting to send the following message: ' + result.content);
23 sforce.console.chat.sendMessage(chatKey, theMessage)
24 alert('The following message has been sent: ' + theMessage);
25 }
26 //Get the value for 'myChatKey' from the sforce.console.chat.getDetailsByPrimaryTabId() or other chat methods.
27 //These values are for example purposes only
28 var chatKey = 'myChatKey';
29 sforce.console.chat.onAgentSend(chatKey, eventHandler);
30 </script>
31</apex:page>応答
このメソッドは非同期であるため、コールバックメソッドのオブジェクトで応答を返します。応答オブジェクトには次のプロパティが含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| content | String | エージェントのメッセージのテキスト。 |
| name | String | メッセージの送信を試みているエージェントの、チャットログに表示される名前。 |
| type | String | 受信されたメッセージの種別 (エージェントなど)。 |
| timestamp | Date/Time | エージェントがチャットメッセージの送信を試みた日時。 |
| success | Boolean | イベントが正常に起動された場合は true、イベントが正常に起動されなかった場合は false。 |