showWhenOffline
showWhenOffline メソッドは、特定のボタンがオフラインの場合に顧客に表示される内容を指定するために使用します。
使用方法
指定したボタン、エージェント、またはボタンへの代替があるエージェントがオフラインの場合に、特定の要素を表示します。API バージョン 28.0 以降で使用できます。
構文
ボタンの場合、userId は省略可能です (void showWhenOffline(String buttonId, Object element, (省略可能) String userId))。
エージェントの場合、buttonId の代わりに userId を使用します。void showWhenOffline(String userId, Object element)
ボタンへの代替があるエージェントの場合、両方の ID を使用します (要素はエージェントまたはボタンがオフラインの場合に表示されます)。void showWhenOffline(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 を指定する場合、要素はボタンとエージェントのいずれも対応できない場合に表示されます。たとえば、次の構文は、エージェントとボタンの状況を追跡して、いずれも対応できない場合に要素を表示します。
1liveagent.showWhenOffline('005xx000001Sv1m', document.getElementById('liveagent_button_toAgent_offline'));1liveagent.showWhenOffline('573xx0000000006', document.getElementById('liveagent_button_offline_573xx0000000006_USER1'), '005xx000001Sv1m');