Lightning Experience の screenPop()

使用方法

入力種別およびパラメーターの指定に従って新しい場所にポップします。このメソッドは API バージョン 38.0 以降で使用できます。

Open CTI for Lightning Experience では、値が [新規のブラウザーウィンドウまたはタブ] の場合、ソフトフォンレイアウト項目 [画面ポップの表示範囲] はサポートされません。Lightning Experience では、デフォルト値は [現在のブラウザーウィンドウ] です。

メモ

構文

1sforce.opencti.screenPop({
2     type: sforce.opencti.SCREENPOP_TYPE.*, //Review the arguments section.
3     params: object //Depends on the SCREENPOP_TYPE. Review the arguments section.
4 });

引数

名前	型	説明
type	string	画面をポップする種別の列挙。次のいずれかの値を使用します。 `sforce.opencti.SCREENPOP_TYPE.SOBJECT` `sforce.opencti.SCREENPOP_TYPE.URL` `sforce.opencti.SCREENPOP_TYPE.OBJECTHOME` `sforce.opencti.SCREENPOP_TYPE.LIST` `sforce.opencti.SCREENPOP_TYPE.SEARCH` `sforce.opencti.SCREENPOP_TYPE.NEW_RECORD_MODAL` `sforce.opencti.SCREENPOP_TYPE.FLOW`
params	object	引数を保持するオブジェクト。種別によって異なります。 SOBJECT の場合: `params : { recordId: string }` ここで、`recordId` は Salesforce の標準オブジェクトまたはカスタムオブジェクトの ID です。 URL の場合: `params : { url: string }` URL は相対パラメーターである必要があります。`URL` についての詳細は、『Lightning Aura コンポーネント開発者ガイド』の `force:navigateToURL` `url` パラメーターを参照してください。 OBJECTHOME の場合: `params : { scope: string }` ケースや取引先などのオブジェクトまたはエンティティのホームにポップします。`scope` についての詳細は、『Lightning Aura コンポーネント開発者ガイド』の `force:navigateToSObject` `recordID` パラメーターを参照してください。次にサンプル入力を示します。 `{ scope: “Account”}` LIST の場合: `{ listViewId: string, scope: string }` `listViewId` および `scope` パラメーターについての詳細は、『Lightning Aura コンポーネント開発者ガイド』の「`force:navigateToList`」を参照してください。 SEARCH の場合: `params : {searchString: string}` 検索ページの [上位の結果] セクションにポップします。文字列は 3 文字以上である必要があります。 NEW_RECORD_MODAL の場合: `1params : {entityName: string, //required defaultFieldValues: object//optional 2}` 必須。カスタムオブジェクトまたは標準オブジェクトの API 参照名 (Account、Case、Contact、Lead など)。カスタムオブジェクトの場合、新しいレコードモデルの名前は次の形式に従います。 `objectName__c` この名前はデフォルトの名前空間を取ります。区切り文字には 2 つのアンダースコアが使用されます。組織で名前空間が有効になっている場合、名前空間をカスタムオブジェクトのプレフィックスとして付ける必要があります。次の形式を使用します。 `namespace__objectName__c` 新しい個人取引先モデルにポップするには、入力 `Account` を使用します。メモ FLOW の場合: `params: {flowDevName: 'Flow_Dev_Name', flowArgs: [{'name': 'Name', 'type': 'Type', 'value': 'Value'}]}` 対象フローにポップします。追加の引数 (発信者の電話番号や一致するレコードのリストなど) をフローに渡すことができます。ポップできるのは、(`Flow` 種別を使用する) 有効な UI 画面フローのみです。フローに渡される引数は、フロー内で変数として定義する必要があります。そうしないと、引数は実行時に無視されます。フローの引数についての詳細は、『メタデータ API 開発者ガイド』のフローに関するトピックで FlowVariable を参照してください。メモ
defaultFieldValues	object	省略可能。(着信通話の) 検索結果がない場合にソフトフォンを新しいエンティティにポップするように設定する場合、この引数を使用して画面ポップのデフォルト項目を指定できます。たとえば、新しいエンティティの画面ポップが開いたときに、指定された項目が事前に設定されます。 `1{ searchParams: 'searchTermWithEmptyResults', 2 callType: 'inbound', 3 defaultFieldValues: {LastName : 'searchAndScreenPopLastName'}, 4 deferred: false, 5 callback: function(result) { 6 if (result.success) { 7 console.log(result.returnValue); 8 } else { 9 console.log(result.errors); 10 } 11 }}`
callback	function	省略可能。API メソッドコールが完了するときに実行された JavaScript メソッド。

サンプルコード – HTML とコールバック付きの JavaScript

1<html>
2	<head>
3   <script type="text/javascript" src="http://domain:port/support/api/60.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 screenPop() {
13                	sforce.opencti.screenPop({type: sforce.opencti.SCREENPOP_TYPE.OBJECTHOME, params: {scope:”Account”}, callback: callback  });
14        	}
15</script>
16</head>
17<body>
18       <button onclick="screenPop();">screenPop</button>
19</body>
20</html>

応答

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

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

Open CTI 開発者ガイド

使用方法

構文

引数

サンプルコード – HTML とコールバック付きの JavaScript

応答

関連項目: