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

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

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

cancelFileTransferByAgent()

使用方法

ファイル転送要求がエージェントによってキャンセルされたことを示します。API バージョン 31.0 以降で使用できます。

構文

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

引数

名前 型 説明
chatKey String エージェントがファイル転送要求をキャンセルしたチャットのチャットキー。
callback function メソッドの完了時にコールされる JavaScript メソッド。

サンプルコード – Visualforce

1swfobject.registerObject("clippy.codeblock-1", "9");<apex:page>
2    <apex:includeScript value="/support/console/31.0/integration.js"/>
3    <a href="#" onClick="testCancelFileTransfer();return false;">Cancel file transfer</a> 
4
5    <script type="text/javascript">
6        function testCancelFileTransfer() {
7            //Gets the value for 'myChatKey'from the getChatRequests() or onChatRequested()
8              methods. 
9            //These values are for example purposes only.
10            var chatKey = 'myChatKey'; 
11            sforce.console.chat.cancelFileTransferByAgent(chatKey, fileSuccess);
12        }
13        
14        function fileSuccess(result) {
15            //Report whether canceling was successful
16            if (result.success == true) {
17                alert('Canceling file transfer was successful.');
18            } else {
19                alert('Canceling file transfer was not successful.');
20            }
21        };
22    </script>
23</apex:page>

応答

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

名前 型 説明
success Boolean ファイル転送要求が正常にキャンセルされた場合は true、ファイル転送要求が正常にキャンセルされなかった場合は false。