この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

disableTabClose()

ユーザがタブまたはサブタブを閉じることができないようにします。ID パラメータでタブが指定されていない場合、囲んでいるタブが使用されます。このメソッドは、無効化されたタブを再有効化するためにも使用できます。API バージョン 36.0 以降で使用できます。

サブタブを閉じないように設定すると、主タブも閉じないようになります。
レコードの主タブが無効化されている場合にそのレコードを削除すると、そのタブは強制的に閉じられます。
レコードのサブタブが無効化されている場合にそのレコードを削除しても、そのサブタブは閉じられません。

メモ

構文

1sforce.console.disableTabClose(disable:boolean, (optional) tabId:String, (optional) callback:Function)

引数

名前	型	説明
disable	boolean	タブを無効化するかどうかを指定します。`true` の場合、ユーザはタブを閉じることができません。`false` の場合、ユーザはタブを閉じることができます。
tabId	string	有効化または無効化するタブのタブ ID。タブ ID を指定せずに、囲んでいるタブまたはサブタブを自動的に選択するには、`false` を使用します。サイドバーコンポーネントの外部からこのコールが行われた場合は囲んでいるタブの ID は推定できません。たとえば、フッターウィジェットからこのメソッドをコールする場合はタブ ID を指定します。タブ ID が主タブの「詳細」サブタブのものである場合は、代わりに主タブ ID が使用されます。
callback	function	メソッドの完了時にコールされる JavaScript メソッド。callback には応答オブジェクトが渡されます。下記の応答情報を参照してください。

サンプルコード – Visualforce

1<apex:page >
2<html>
3  <head>
4    <title>Disable close Tab on Load</title>
5
6    <!-- Service Console integration API library -->
7    <script src="/support/console/49.0/integration.js"></script>
8
9    <!-- Callback functions to handle tab events -->
10    <script type="text/javascript">
11
12      function displayResultsCallback(result){
13        var resDiv = document.getElementById("eventResults");
14        resDiv.innerHTML = JSON.stringify(result);
15      }
16
17      // For use within a tab's sidebar (you don't need tab ID)
18
19      function testDisableTabCloseTrueWithoutId() {
20        sforce.console.disableTabClose(true, false, displayResultsCallback);
21      }
22
23      function testDisableTabCloseFalseWithoutId() {
24        sforce.console.disableTabClose(false, false, displayResultsCallback);
25      }
26
27      // For use anywhere (you need the tab ID)
28
29      // Note: Your tab ID might be different than the one used here. 
30      //       You can get the tab ID many different ways,
31      //       including sforce.console.getEnclosingTabId().
32      //       See the documentation for details.
33      function testDisableTabCloseTrueWithId() {
34        var tabId = window.prompt("Enter the tab ID","scc-pt-0");
35        sforce.console.disableTabClose(true, tabId, displayResultsCallback);
36      }
37
38      function testDisableTabCloseFalseWithId() {
39        var tabId = window.prompt("Enter the tab ID","scc-pt-0");
40        sforce.console.disableTabClose(false, tabId, displayResultsCallback);
41      }
42     
43    </script>
44  </head>
45
46  <body>
47    <h1>Disable Tab Close Examples</h1>
48    <br/><br/>
49     
50    <h2>API Callback Result</h2>
51    <br/>
52    
53    <code><div id="eventResults" /></code>
54    <br/>
55
56    <h2>With No Tab ID</h2>
57    <p>The tab ID will be auto-detected by context, or the event will fail.</p>
58
59    <ul>
60    <li><a href="#" onClick="testDisableTabCloseTrueWithoutId();return false;">
61    Disable closing for the enclosing tab</a></li>
62
63    <li><a href="#" onClick="testDisableTabCloseFalseWithoutId();return false;">
64    Re-enable closing for the enclosing tab</a></li>
65    </ul>
66     
67    <h2>With Tab ID Provided</h2>
68    <p>When the event context doesn't have a detectable tab ID, you can 
69    supply it yourself.</p>
70
71    <ul>
72    <li><a href="#" onClick="testDisableTabCloseTrueWithId();return false;">
73    Disable closing for a specific tab (via tab ID)</a></li>
74
75    <li><a href="#" onClick="testDisableTabCloseFalseWithId();return false;">
76    Re-enable closing for a specific tab (via tab ID)</a></li>
77    </ul>
78
79  </body>
80</html>
81</apex:page>

応答

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

名前	型	説明
success	boolean	アクションが正常に完了した場合は `true`、それ以外の場合は `false` を返します。
message	string	アクションが正常に完了した場合は、message には影響を受けるタブ ID が格納されます。アクションが失敗した場合は、message にはエラーメッセージが格納されます。

Salesforce コンソール開発者ガイド

disableTabClose()

構文

引数

サンプルコード – Visualforce

応答