Lightning Experience の notifyInitializationComplete() | Open CTI 開発者ガイド

使用方法

Salesforce に、ソフトフォンの初期化が完了したことと、Salesforce がスタンバイ URL に切り替えないようにすることを通知します。ソフトフォンの初期化中は、ソフトフォン領域に読み込み中アイコンが表示されます。スタンバイ URL を使用するには、コールセンターの定義ファイルの reqStandbyUrl 項目と reqTimeout 項目を指定する必要があります。詳細は、「コールセンターの省略可能な要素と属性」を参照してください。

Lightning Experience の notifyInitializationComplete() メソッドは、Salesforce Classic のメソッドと動作が異なります。

Lightning Experience では、このメソッドは省略可能なコールバックオブジェクトを取ります。Salesforce Classic では、このメソッドは引数を取りません。
Lightning Experience では、スタンバイ URL に移動した後、ブラウザセッションでそのスタンバイ URL の使用が継続されます。スタンバイ URL チェックを強制的に行うには、ブラウザを再起動する (ブラウザを閉じて再度開く) 必要があります。Salesforce Classic では、スタンバイ URL チェックは、Salesforce へのログイン後にのみ実行され、同じ Salesforce セッションを使用し続ける場合は、チェックは繰り返されませんでした。

構文

1sforce.opencti.notifyInitializationComplete({
2     callback: function //Optional
3});

引数

名前	型	説明
callback	function	API メソッドコールが完了するときに実行された JavaScript メソッド。

サンプルコード – HTML および JavaScript

1<html>
2  <head>
3    <script type="text/javascript" src="http://domain:port/support/api/56.0/lightning/opencti_min.js"></script>
4    <script type="text/javascript">
5      // Invokes API method
6      sforce.opencti.notifyInitializationComplete();
7    </script>
8  </head>
9  <body>
10    The Open CTI framework was notified that the softphone initialization is complete.
11  </body>
12</html>

応答

このメソッドは非同期です。応答は、コールバックメソッドに渡されたオブジェクトで返されます。応答オブジェクトには次の項目が含まれます。

名前	型	説明
success	boolean	API メソッドコールが正常に呼び出された場合は `true`、それ以外の場合は `false` が返されます。
returnValue	object	この API メソッドはこのオブジェクトを返しません。returnValue は常に `null` になります。
errors	array	API コールが正常に行われた場合、この変数は `null` になります。API コールが失敗した場合、この変数はエラーメッセージの配列を返します。