Service Cloud チャット開発者ガイド
jpreChatInit
preChatInit メソッドは、addCustomDetail リリース API メソッドを使用してチャットに渡されたリリース情報にアクセスするために使用します。
使用方法
事前チャットで使用するカスタム詳細などのチャットリリース情報を抽出します。preChatInit を使用する場合、prechat.js ファイルを deployment.js ファイルと同じパスの同じ Apex ページに含めます。
構文
liveagent.details.preChatInit(String chatUrl, function detailCallback, (optional) String chatFormName)
パラメータ
| 名前 | 型 | 説明 | 使用可能なバージョン |
|---|---|---|---|
| chatUrl | String | カスタム詳細を取得するチャットの URL。 | API バージョン 29.0 以降で使用できます。 |
| detailCallback | String | メソッドの完了時にコールされる JavaScript 関数の名前。 | API バージョン 29.0 以降で使用できます。 |
| (省略可能) chatFormName | String | カスタム詳細を取り込む事前チャットフォームの HTML form タグの名前。 | API バージョン 29.0 以降で使用できます。 |
応答
| 名前 | 型 | 説明 | 使用可能なバージョン |
|---|---|---|---|
| details | Object | preChatInit メソッドを使用して事前チャットフォームに格納されたリリース情報を含むオブジェクト。 | API バージョン 29.0 以降で使用できます。 |
detailCallback
detailCallback メソッドは、preChatInit メソッドが details オブジェクトを返した後に発生する動作を指定します。
| 構文 | パラメータ | 説明 | 使用可能なバージョン |
|---|---|---|---|
| function myCallBack(details) { // Customer specific code } | details | preChatInit メソッドを使用してカスタム詳細が取得された後に実行されるアクションを指定します。 | API バージョン 29.0 以降で使用できます。 |