Open CTI 開発者ガイド
jLightning Experience の getSoftphoneLayout()
使用方法
現在のユーザのソフトフォンレイアウトを返します。このメソッドは API バージョン 38.0 以降で使用できます。
構文
1sforce.opencti.getSoftphoneLayout({
2 callback: function
3});引数
| 名前 | 型 | 説明 |
|---|---|---|
| callback | function | API メソッドコールが完了するときに実行された JavaScript メソッド。 |
サンプルコード – HTML および JavaScript
1<html>
2<head>
3 <script type="text/javascript" src="https://domain:port/support/api/47.0/lightning/opencti_min.js"></script>
4 <script type="text/javascript">
5 var callback = function(response) {
6 if (response.success) {
7 alert(response.returnValue);
8 } else {
9 console.error(response.errors);
10 alert(
11 'Something went wrong. Please check error information in developer console.'
12 );
13 }
14 };
15
16 function getSoftphoneLayout() {
17 sforce.opencti.getSoftphoneLayout({
18 callback: callback
19 });
20 }
21 </script>
22</head>
23<body>
24 <button onclick="getSoftphoneLayout();">Get Softphone Layout</button>
25</body>
26</html>応答
このメソッドは非同期です。応答は、コールバックメソッドに渡されたオブジェクトで返されます。応答オブジェクトには次の項目が含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| success | boolean | API コールが正常に行われた場合、値 true が返されて returnValue でソフトフォンレイアウト定義が返され、それ以外の場合は false が返されます。 |
| returnValue | object | API コールが正常に行われた場合、ソフトフォンレイアウト定義が返されます。API コールが失敗した場合、null が返されます。 返されたオブジェクトには、各通話種別を表す 3 つの要素が含まれます。
各通話種別には 3 つのサブセクションが含まれます。
次に、returnValue の例を示します。
|
| errors | array | API コールが正常に行われた場合、この変数は null になります。API コールが失敗した場合、この変数はエラーメッセージの配列を返します。 |