Lightning Experience の setSoftphoneItemIcon()
使用方法
ユーティリティバーのソフトフォン項目のアイコンを設定します。関数の実行が成功した場合は true を返し、失敗した場合は false を返します。このメソッドは API バージョン 38.0 以降で使用できます。
ユーティリティバーのソフトフォンアイコン。![]()
構文
引数
| 名前 | 型 | 説明 |
|---|---|---|
| key | string | ユーティリティバーのソフトフォンアイコンに使用する Lightning Design System 内のアイコンに対応するキー。 |
| callback | function | API メソッドコールが完了するときに実行された JavaScript メソッド。 |
サンプルコード – HTML および JavaScript
応答
このメソッドは非同期です。応答は、コールバックメソッドに渡されたオブジェクトで返されます。応答オブジェクトには次の項目が含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| success | boolean | API メソッドコールの呼び出しが成功した場合は true、それ以外の場合は false。 |
| returnValue | object | この API メソッドはこのオブジェクトを返しません。returnValue は常に null になります。 |
| errors | array | API コールが正常に行われた場合、この変数は null になります。API コールが失敗した場合、この変数はエラーメッセージの配列を返します。 |