Open CTI 開発者ガイド
jLightning Experience の searchAndScreenPop()
使用方法
特定の文字列に対してソフトフォンレイアウトで指定されたオブジェクトを検索します。検索結果を返し、一致するレコードが画面にポップされます。このメソッドは、ソフトフォンレイアウトで定義された画面ポップ設定を優先します。このメソッドは API バージョン 38.0 以降で使用できます。
ソフトフォンレイアウトのデフォルト設定で動作に矛盾がある場合には、ソフトフォンレイアウトを編集してキャッシュを強制的に更新します。[設定] からソフトフォンレイアウトを編集し、変更を保存します。次に、レイアウトをもう一度編集し、レイアウトをデフォルト設定にリセットします。
構文
1sforce.opencti.searchAndScreenPop({
2 searchParams:string //Optional
3 queryParams:string, //Optional
4 callType:sforce.opencti.CALL_TYPE.*, //Required. See arguments for more information.
5 deferred:boolean //Optional)
6 callback:function //Optional
7});引数
| 名前 | 型 | 説明 |
|---|---|---|
| searchParams | string | 検索対象の文字列。 |
| queryParams | string | URL に渡すクエリパラメータを指定します。画面ポップオプションが Pop to Visualforce に設定されている場合のみ、クエリパラメータが URL に渡されます。 |
| callType | string | 着信、発信、内線、または null などの通話種別を指定します。通話種別は、ソフトフォンレイアウトでの設定ごとに、語句検索を行うオブジェクトを決定します。 次のいずれかの値によって通話種別を指定します。
|
| deferred | boolean | 画面ポップが検索の直後に実行されるか後で実行されるかを指定します。画面ポップが後で実行される場合は、JSON オブジェクトが返されます。操作を実行するには、このオブジェクトを変更せずに sforce.opencti.screenPop に渡す必要があります。
|
| callback | function | API メソッドコールが完了するとき��実行された JavaScript メソッド。 |
サンプルコード – HTML および JavaScript
1<html>
2<head>
3 <script type="text/javascript" src="http://domain:port/support/api/38.0/lightning/opencti_min.js"></script>
4 <script type="text/javascript">
5 var callback = function(response) {
6 if (response.success) {
7 console.log('API method call executed successfully! returnValue:', response.returnValue);
8 } else {
9 console.error('Something went wrong! Errors:', response.errors);
10 }
11 };
12 function searchAndScreenPop() {
13 //Invokes API method
14 sforce.opencti.searchAndScreenPop({ searchParams : 'Acme',queryParams : 'Key1=value1&Key2=value2', callType : sforce.opencti.CALL_TYPE.INBOUND, deferred: false, callback : callback });
15 }
16 </script>
17</head>
18<body>
19 <button onclick="searchAndScreenPop();">searchAndScreenPop</button>
20</body>
21</html>応答
| 名前 | 型 | 説明 |
|---|---|---|
| success | boolean | API メソッドコールが正常に呼び出された場合は true、それ以外の場合は false が返されます。 |
| returnValue | object | 検索結果に一致するオブジェクトのリストを返します。検索は、ソフトフォンレイアウトで指定されたオブジェクトで実行されます。検出されたオブジェクトごとに、オブジェクト ID、オブジェクトタブ名、項目名、および項目値が JSON オブジェクトとして返されます。 次に、「Acme」を検索し、1 つの取引先オブジェクトと 3 つの商談オブジェクトが検出された例を示します。
この API メソッドを deferred パラメータを指定して呼び出すと、画面は移動せずに次のサンプル出力が返されます。
個人取引先でこの API メソッドを呼び出すと、追加情報が返されます。
|
| errors | array | API コールが正常に行われた場合、この変数は null になります。API コールが失敗した場合、この変数はエラーメッセージの配列を返します。 |