Salesforce コンソールインテグレーションツールキット開発者ガイド
jdisableTabClose()
ユーザがタブまたはサブタブを閉じることができないようにします。ID パラメータでタブが指定されていない場合、囲んでいるタブが使用されます。このメソッドは、無効化されたタブを再有効化するためにも使用できます。API バージョン 37.0 以降で使用できます。注意: レコードの主タブが無効化されている場合にそのレコードを削除すると、そのタブは強制的に閉じられます。レコードのサブタブが無効化されている場合にそのレコードを削除しても、そのサブタブは閉じられません。
構文
引数
| 名前 | 型 | 説明 |
|---|---|---|
| disable | boolean | タブを無効化するかどうかを指定します。true の場合、ユーザはタブを閉じることができません。false の場合、ユーザはタブを閉じることができます。 |
| tabId | string | 有効化または無効化するタブのタブ ID。タブ ID を指定せずに、囲んでいるタブまたはサブタブを自動的に選択するには、false を使用します。サイドバーコンポーネントの外部からこのコールが行われた場合は囲んでいるタブの ID は推定できません。たとえば、フッターウィジェットからこのメソッドをコールする場合はタブ ID を指定します。タブ ID が主タブの「詳細」サブタブのものである場合は、代わりに主タブ ID が使用されます。 |
| callback | function | メソッドの完了時にコールされる JavaScript メソッド。callback には応答オブジェクトが渡されます。下記の応答情報を参照してください。 |
サンプルコード – Visualforce
応答
このメソッドは非同期であるため、コールバックメソッドのオブジェクトで応答を返します。応答オブジェクトには次の項目が含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| success | boolean | アクションが正常に完了した場合は true、それ以外の場合は false を返します。 |
| message | string | アクションが正常に完了した場合は、message には影響を受けるタブ ID が格納されます。アクションが失敗した場合は、message にはエラーメッセージが格納されます。 |