この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

最小化されたチャットウィンドウのイベント

最小化された組み込みサービス Aura コンポーネントの eventHandlerFunction では次のイベントを使用します。

eventHandlerFunction は 2 つの位置引数 eventName と eventData と共にコールされます。

eventName に使用できる値と対応するシナリオを次に示します。

いくつかのイベントは、シナリオごとに複数回起動されます。安全に複数回実行できないロジックを記述することは避けてください。

メモ

eventName	シナリオ
chatConferenceState	次の場合に起動されます。エージェントが 1 対 1 のチャットに参加し、そのチャットがチャット会議になった。エージェントがチャット会議に参加した。エージェントがチャット会議を退席した。チャット会議に 2 人のエージェントが参加しており、1 人のエージェントが会議を退席したために 1 対 1 のチャットになった。
chatEndedState	何らかの理由でチャットが終了したときに起動されます。
chatState	次の場合に起動されます。訪問者のチャット要求が受け入れられ、訪問者がエージェントとチャットしている。チャットを開始した後に訪問者が別のページに移動し、チャットを再開した。チャット転送が完了し (`chatTransferringState` 参照)、訪問者が新しいエージェントとチャットしている。訪問者が以前に接続を失い (`reconnectingState` を参照)、再接続している。
chatTimeoutUpdate	訪問者のアイドルタイムアウトが開始されたときと、訪問者のアイドル状態が続いている間の 1 秒ごとに起動されます。
chatTransferringState	チャット転送が開始されたときに起動されます。
chatUnreadMessage	訪問者がエージェントからのメッセージを受信したが、まだ読んでいないときに毎回起動されます。
offlineSupportState	オフラインサポートフォームが読み込まれたときに起動されます。
prechatState	事前チャットフォームが読み込まれたときに起動されます。
postchatState	事後チャットフォームが読み込まれたときに起動されます。
queueUpdate	次の場合に起動されます。訪問者がチャットを要求してエージェントを待機している。チャットの要求後、訪問者が別のページに移動して引き続きエージェントを待機している。訪問者が以前に接続を失い (`reconnectingState` を参照)、再接続している。訪問者がキュー内で前進し、エージェントがチャット要求を受け入れるのを引き続き待機している。ボットまたはエージェントがチャット転送を要求し、別のエージェントが受け入れるのを待機している。チャット転送中、訪問者が別のページに移動して引き続き転送を待機している。訪問者がキュー内で前進し、エージェントがチャット転送を受け入れるのを待機している。このイベントは、組み込みサービスリリースでキューの位置が有効になっていて、組み込みサービスのコードスニペットがバージョン 5.0 以降の場合のみ起動します。メモ
reconnectingState	訪問者が接続を失ったときに起動されます。
waitingEndedState	訪問者のチャット要求が何らかの理由で失敗したときに起動されます。
waitingState	次の場合に起動されます。訪問者がチャットを要求してエージェントを待機している。チャットの要求後、訪問者が別のページに移動して引き続きエージェントを待機している。訪問者が以前に接続を失い (`reconnectingState` を参照)、再接続している。このイベントは、組み込みサービスリリースでキューの位置が無効になっているか、組み込みサービスのコードスニペットがバージョン 5.0 より前の場合のみ起動します。メモ

eventData はイベントのデフォルトのローカライズされた表示ラベルを含むオブジェクトです。一部のイベントでは、追加の値も含まれています。eventData に使用できる追加の値を次に示します。

eventName	プロパティ	型	説明
chatConferenceState	agentsInChat	String の配列	チャット会議内のエージェントのリスト。
	agentName	string	チャット会議に参加する、またはチャット会議を退席するエージェントの名前。
	isAgentJoining	boolean	エージェントがチャット会議に参加する (true) かチャット会議を退席する (false) かを示すブール値。
chatEndedState	reason	string	チャットが終了した理由の説明。値には、次のものがあります。 agentEndedChat – エージェントがチャットを終了した。 visitorConnectionError – 訪問者が長い時間接続を失った。 visitorEndedChat – 訪問者がチャットを終了した。 visitorTimeout – 訪問者が長い間アイドル状態になり、チャットがタイムアウトした。
chatState	agentName	string	エージェントの名前。
chatState	agentType	string	チャットに対応するエージェントの種別。使用できる値は agent (サポートエージェント) と chatbot (Einstein ボット) です。
chatTimeoutUpdate	timeoutSecondsRemaining	int	訪問者が長い間アイドル状態であるためにチャットがタイムアウトするまでの残り��数。
chatUnreadMessage	unreadMessageCount	int	未読メッセージの数。
chatUnreadMessage	agentType	string	チャットに対応するエージェントの種別。使用できる値は agent (サポートエージェント) と chatbot (Einstein ボット) です。
queueUpdate	queuePosition	int	訪問者の現在の順番。
waitingEndedState	reason	string	訪問者のチャット要求が失敗した理由の説明。値には、次のものがあります。 agentsUnavailable – すべてのエージェントが対応不可能であったか、エージェントがチャット要求を拒否した。 connectionError – その他の理由でチャット要求が失敗した。 visitorBlocked – 訪問者の IP アドレスがブロックされた。

Web 用組み込みサービス開発者ガイド

最小化されたチャットウィンドウのイベント