Lightning Experience の sendMessage()
特定のチャットキーを持つチャットに、エージェントから新しいチャットメッセージを送信します。このメソッドは、Lightning コンソールアプリケーションでのみ機能します。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| argumentObj | Object | このメソッドに渡されるすべての引数が含まれるオブジェクト。 |
argumentObj
| 名前 | 型 | 説明 |
|---|---|---|
| recordId | String | 終了するチャットの ID。 |
| message | Object | メッセージで送信するデータが含まれるオブジェクト。 |
message
| 名前 | 型 | 説明 |
|---|---|---|
| text | String | メッセージで送信されるテキスト。 |
サンプルコード
この例では、メッセージを訪問者に送信して結果を保存します。
コンポーネントコード:
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="sendMessage" press="{!c.sendMessage}" />
5</aura:component>コントローラコード:
1({
2 sendMessage: function(cmp, evt, helper) {
3 var conversationKit = cmp.find("conversationKit");
4 var recordId = cmp.get("v.recordId");
5 conversationKit.sendMessage({
6 recordId: recordId,
7 message: {
8 text:"Hi, this was sent using the sendMessage API!"
9 }
10 })
11 .then(function(result){
12 if (result) {
13 console.log("Successfully sent message");
14 } else {
15 console.log("Failed to send message");
16 }
17 });
18 }
19})応答
Promise を返します。成功すると、true に解決されます。エラーがある場合、Promise は却下されます。