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

Lightning Experience の getChatLog()

特定の recordId に関連付けられたチャットのチャットログを返します。このメソッドは、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  <aura:attribute name="chatLog" type="Object" />
4  <lightning:conversationToolkitAPI aura:id="conversationKit" />
5  <ui:button label="getChatLog" press="{!c.getChatLog}" />
6</aura:component>

コントローラーコード:

1({
2    getChatLog: function(cmp, evt, helper) {
3        var conversationKit = cmp.find("conversationKit");
4        var recordId = cmp.get("v.recordId");
5        conversationKit.getChatLog({
6            recordId: recordId
7        })
8        .then(function(result){
9            if (result) {
10                    console.log("Successfully retrieved chat log");
11                    cmp.set("v.chatLog", result);
12                } else {
13                    console.log("Failed to retrieve chat log");
14                }
15        });
16    }
17})

応答

Promise を返します。成功すると、messages および customEvents プロパティが含まれる response オブジェクトに解決されます。エラーがある場合、Promise は却下されます。

名前	型	説明
customEvents	`customEvent` オブジェクトの配列。	チャット中に発生したカスタムイベントを表すカスタムイベントオブジェクトの配列。
messages	message オブジェクトの配列。	チャットログのすべてのチャットメッセージを含むチャットメッセージオブジェクトの配列。
success	Boolean	チャットログが正常に取得された場合は `true`、チャットログが正常に取得されなかった場合は `false`。

customEvent

customEvent オブジェクトには、チャットログの単一のイベントと次のプロパティが含まれます。

プロパティ	型	説明
source	String	カスタムイベントを開始したユーザー (チャット訪問者またはエージェント)。
type	String	発生したカスタムイベントのタイプ。
data	String	チャットに送信されたカスタムイベントのデータ。チャットウィンドウからこのイベントを送信するために使用された `liveagent.chasitor.sendCustomEvent()` メソッドの data 引数に対応します。
timestamp	Date/Time	カスタムイベントの受信日時。

message

message オブジェクトには、チャットログの単一のチャットメッセージと次のプロパティが含まれます。

プロパティ	型	説明
content	String	チャットログのメッセージのテキスト内容。
name	String	チャットログのメッセージを送信したユーザーの名前。この名前は、チャットログとまったく同じように表示されます。
type	String	受信メッセージの種別 (エージェントや訪問者など)。
timestamp	Date/Time	チャットメッセージの受信日時。

Salesforce コンソール開発者ガイド

Lightning Experience の getChatLog()

引数

argumentObj

サンプルコード

応答

customEvent

message