Lightning Experience の getChatLog()
特定の recordId に関連付けられたチャットのチャットログを返します。このメソッドは、Lightning コンソールアプリケーションでのみ機能します。
引数
| 名前 | 種別 | 説明 |
|---|---|---|
| argumentObj | Object | このメソッドに渡されるすべての引数が含まれるオブジェクト。 |
argumentObj
| 名前 | 種別 | 説明 |
|---|---|---|
| recordId | String | 現在のチャットに関連付けられている作業の ID。 |
サンプルコード
この例では、特定のチャットのチャットログを取得して結果を記録し、成功した場合はその結果を変数に保存します。
コンポーネントコード:
コントローラコード:
応答
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 | カスタムイベントの受信日時。 |