showWhenOnline
showWhenOnline メソッドは、特定のボタンがオンラインの場合に顧客に表示される内容を指定するために使用します。
使用方法
指定したボタン、エージェント、またはボタンへの代替があるエージェントがオンラインの場合に、特定の要素を表示します。API バージョン 28.0 以降で利用できます。
構文
ボタンの場合、userId は省略可能です。void showWhenOnline(String buttonId, Object element, (optional) String userId)
エージェントの場合、buttonId の代わりに userId を使用します。void showWhenOnline(String userId, Object element)
ボタンへの代替があるエージェントの場合、両方の ID を使用します (要素はエージェントまたはボタンがオンラインの場合に表示されます)。void showWhenOnline(String buttonId, Object element, String userId)
パラメータ
| 名前 | 型 | 説明 | 使用可能なバージョン |
|---|---|---|---|
| buttonId | String | ボタンに関連付けられているエージェントがチャットに対応できる場合に、指定した element オブジェクトを表示するチャットボタンの ID。 | API バージョン 28.0 以降で使用できます。 |
| element | Object | 指定したボタンがオンラインの場合に表示する要素。 | API バージョン 28.0 以降で使用できます。 |
| userId | String | ボタンに関連付けるエージェントの ID。エージェントが対応できる場合に、element オブジェクトが表示されます。 | API バージョン 29.0 以降で使用できます。 |
パラメータにボタン ID を指定してユーザ ID は指定しない場合、要素はボタンがオンラインの場合にのみ表示されます。
ユーザ ID を指定してボタン ID は指定しない場合、要素はエージェントがオンラインの場合にのみ表示されます。たとえば、次の構文は、エージェントのオンライン状況を追跡し、エージェントが対応できる場合はボタンをオンラインに設定して、対応できない場合はオフラインに設定します。
ボタン ID とエージェント ID を指定する場合、要素はボタンとエージェントのいずれかがオンラインの場合に表示されます。たとえば、次の構文は、エージェントとボタンの状況を追跡して、スキルのある 1 人以上のエージェントが対応できる場合に要素を表示します。
1liveagent.showWhenOnline('005xx000001Sv1m', document.getElementById('liveagent_button_toAgent_online'));1liveagent.showWhenOnline('573xx0000000006', document.getElementById('liveagent_button_online_573xx0000000006_USER1'), '005xx000001Sv1m');