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

endChat()

エージェントが現在参加しているチャットを終了します。API バージョン 29.0 以降で使用できます。

構文

1sforce.console.chat.endChat(chatKey:String, (optional)callback:Function)

引数

名前	型	説明
chatKey	String	終了する参加中のチャットのチャットキー。
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    <a href="#" onClick="testEndChat();return false;">End Chat</a> 
20
21    <script type="text/javascript">
22        function testEndChat() {
23            //Get the value for 'myChatKey'from the getEngagedChats() or onChatStarted() methods. 
24            //These values are for example purposes only
25            var chatKey = 'myChatKey';
26            sforce.console.chat.endChat(chatKey, endSuccess);
27        }
28    
29        function endSuccess(result) {
30            //Report whether ending the chat was succesful
31            if (result.success == true) {
32                alert('Ending the chat was successful');
33            } else {
34                alert('Ending the chat was not successful');
35            }
36        };
37    </script>
38</apex:page>

応答

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

名前	型	説明
success	Boolean	チャットが正常に終了された場合は `true`、チャットが正常に終了されなかった場合は `false`。

Salesforce コンソールインテグレーションツールキット開発者ガイド

endChat()

構文

引数

サンプルコード – Visualforce

応答