Salesforce コンソール開発者ガイド
jLightning 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 が含まれる response オブジェクトに解決されます。エラーがある場合、Promise は却下されます。
| 名前 | 型 | 説明 |
|---|---|---|
| messages | message オブジェクトの配列。 | チャットログのすべてのチャットメッセージを含むチャットメッセージオブジェクトの配列。 |