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} 
5});

引数

名前	型	説明
type	string	画面をポップする種別の列挙。次のいずれかの値を使用します。 `sforce.opencti.SCREENPOP_TYPE.SOBJECT` `sforce.opencti.SCREENPOP_TYPE.URL` `sforce.opencti.SCREENPOP_TYPE.OBJECTHOME` `sforce.opencti.SCREENPOP_TYPE.LIST`
params	object	引数を保持するオブジェクト。種別によって異なります。 SOBJECT の場合: `params : { recordId: string }` ここで、`recordId` は Salesforce の標準オブジェクトまたはカスタムオブジェクトの ID です。 URL の場合: `params : { url: string }` URL は相対パラメータである必要があります。`URL` についての詳細は、『Lightning コンポーネント開発者ガイド』の`force:navigateToURL` `url`を参照してください。 OBJECTHOME の場合: `params : { scope: string }` ケースや取引先などのオブジェクトまたはエンティティのホームにポップします。`scope` についての詳細は、『Lightning コンポーネント開発者ガイド』の`force:navigateToSObject` `recordID`を参照してください。次にサンプル入力を示します。 `{ scope: “Account”}` LIST の場合: `{ listViewId: string, scope: string }` `listViewId` および `scope` パラメータについての詳細は、『Lightning コンポーネント開発者ガイド』の`force:navigateToList`を参照してください。
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 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

応答

関連項目: