指定されたタブにアイコンを設定します。タブが指定されていない場合、アイコンは囲んでいるタブに設定されます。このメソッドを使って、タブのアイコンをカスタマイズします。このメソッドは、API バージョン 28.0 以降でのみ使用できます。
引数
| iconUrl |
string |
タブのアイコンとして使用される画像を指し示す URL。null または未定義の場合、タブのデフォルトアイコンが使用されます。 |
| tabId |
string |
アイコンを設定するタブの ID。null または未定義の場合、囲んでいるタブの ID が使用されます。 |
| callback |
function |
メソッドの完了時にコールされる JavaScript メソッド。 |
応答
このメソッドは非同期であるため、コールバックメソッドのオブジェクトで応答を返します。応答オブジェクトには次の項目が含まれます。
| success |
boolean |
タブのアイコンの設定に成功した場合は true、タブのアイコンの設定に失敗した場合は false。 |
タブ ID を渡さずにこのメソッドをコールすると、Visualforce ページを囲んでいるタブが使用されます。囲んでいるタブがない場合、ブラウザーの開発者コンソールに Cannot get a workspace or view tab from the given ID (指定された ID で [ワークスペース] タブまたは [ビュー] タブを取得できません) というエラーメッセージが表示されます。
j