Salesforce コンソール開発者ガイド
jLightning Experience の endChat()
エージェントが現在参加しているチャットを終了します。このメソッドは、Lightning コンソールアプリケーションでのみ機能します。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| argumentObj | Object | このメソッドに渡されるすべての引数が含まれるオブジェクト。 |
argumentObj
| 名前 | 型 | 説明 |
|---|---|---|
| recordId | String | 終了するチャットの ID。 |
サンプルコード
この例では、チャットを終了して結果を記録します。
コンポーネントコード:
1<aura:component implements="flexipage:availableForAllPageTypes" access="global" description="Conversation toolkit api sample">
2 <aura:attribute name="recordId" type="String" />
3 <lightning:conversationToolkitAPI aura:id="conversationKit" />
4 <ui:button label="endChat" press="{!c.endChat}" />
5</aura:component>コントローラーコード:
1({
2 endChat: function(cmp, evt, helper) {
3 var conversationKit = cmp.find("conversationKit");
4 var recordId = cmp.get("v.recordId");
5 conversationKit.endChat({
6 recordId: recordId
7 })
8 .then(function(result){
9 if (result) {
10 console.log("Successfully ended chat");
11 } else {
12 console.log("Failed to end chat");
13 }
14 });
15 }
16})応答
Promise を返します。成功すると、true に解決されます。エラーがある場合、Promise は却下されます。