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

Lightning Experience 用の Lightning Message Service のメソッド

使用方法

Lightning Message Service も使用されている他の Visualforce、Aura、Lightning の各コンポーネントに対し、CTI 実装を通じて通信を行うには、次の 3 つのメソッドを使用します。subscribe メソッドは、指定された Lightning メッセージチャネルにリスナ関数を接続します。publish メソッドは、Lightning メッセージチャネルでメッセージを送信できるようにします。unsubscribe メソッドは、subscribe メソッドで追加されたリスナ関数を削除できるようにします。

これらのメソッドは、API バージョン 47.0 以降で使用できます。

これらのメソッドは、Lightning Experience でのみ使用できます。iFrame および Visualforce コンポーネント内で使用可能です。

メモ

構文

subscribe メソッドを使用すると、指定された Lightning メッセージチャネルにリスナ関数を接続できます。Lightning メッセージサービスは、コンポーネントからメッセージが送信されると、リスナ関数をコールします。

1var SAMPLEMC = "SAMPLEMC__c";
2var SAMPLEMC_SUBSCRIPTION = null; 
3sforce.opencti.subscribe({channelName: SAMPLEMC, listener: onPublishMessage, callback: subscribeSampleMCCallback});

subscribe の引数

名前 型 説明
channelName string 登録できるメッセージチャネルの名前。
listener function メッセージがメッセージチャネルで送信されたときにコールされる JavaScript メソッド。
callback function API メソッドコールの完了時に実行される JavaScript メソッド。

unsubscribe の引数

名前 型 説明
subscription object リスナ関数を削除できるサブスクリプション。
callback function API メソッドコールの完了時に実行される JavaScript メソッド。

publish の引数

名前 型 説明
channelName string 登録できるメッセージチャネルの名前。
message object メッセージチャネルで送信される逐次化可能な JSON オブジェクト。
callback function API メソッドコールの完了時に実行される JavaScript メソッド。