Mobile SDKイベントダイアグラム

新しいウィンドウで図を開く

初期状態：

• SDKの初期ステータスはinitialに設定されています。

• モバイルアプリは前景に入ります。

チャットの準備：

• ユーザーはprepare(brandId:channelId:)を呼び出してチャットの準備を開始します。

• チャットの状態が初期状態またはオフラインでない場合、IllegalChatStateErrorが返されます。

• そうでない場合、SDKはチャット状態をpreparingに設定し、onChatUpdated()でUIに通知します。

チャンネル構成：

• SDKはバックエンドにgetChannelConfiguration())でチャネル設定をリクエストします。

• サーバーエラーが発生した場合、ServerErrorが返され、チャットの状態はinitializeにリセットされます。

• そうでない場合は、チャネル設定が受信され、SDKは宛先IDを作成します。

• 訪問者IDまたは顧客IDがnullの場合、ローカルで作成され保存されます。

訪問者および顧客への対応：

• SDKはバックエンドでcreateOrUpdateVisitor(visitorId:customerId:deviceToken:)を呼び出します。

• サーバーエラーが発生した場合、チャットの状態は initializeにリセットされます。

• そうでない場合、訪問者や顧客への対応は成功します。

チャット準備完了状態：

• チャットの状態はpreparedに設定されています。

• UIはonChatUpdated()で通知されます。

• ページビューの分析は、モバイルアプリとバックエンドの間で追跡されます。

新しいウィンドウで図を開く

背景に入るアプリケーション：

• UIは、アプリケーションが背景に入っていることを示すボックスを表示します。

• UIは、pageViewEndedを使用してページビューが終了したことをSDKに通知します。

• 背景はpageViewEndedイベントを受信します。

  • サーバー エラーがあれば、それは処理される。

  • それ以外ではイベントは成功します。

切断と状態の対応：

• UIはdisconnect()を使って切断を開始する。

• 現在の状態に応じて：

  • 準備中の場合、SDKは状態をinitialに設定します。

  • すでに準備できている場合、SDKはソケットを切断し、状態をpreparedビューページに設定します。

新しいウィンドウで図を開く

アプリケーションアクティベーション参照先：

• この図は、アプリケーションがアクティブになったイベントを参照します。

ページ閲覧イベント：

• ユーザーはページを閲覧し、UIはSDKにviewPage(title:url:)を通知します。

• チャットモードにチェックが入っています：

  • 準備されていない場合は、illegalChatStateErrorが返されます。

  • そうでない場合は、訪問の詳細が有効期限切れかどうかチェックされます。

    • 期限が切れている場合は、新しい訪問詳細が作成される(UUIDと有効期限)。

    • 有効な場合、SDKは現在の有効期限を調整します。

  • 最後に閲覧したページが送信されていない場合、SDKはページビューを終了します。

  • 現在の最後に閲覧したページのタイトル、URI、タイムスタンプは保存されます。

  • サーバーエラーのような失敗があれば、それは処理されます。

バックエンドインタラクション：

• SDKはバックエンドサービスと通信します：

  • visitorVisit(date:)が呼び出されて訪問を記録します。

  • pageView(title:uri:timestamp)が呼び出されてページビューを記録します。

  • サーバー エラーがあれば、それは処理される。

新しいウィンドウで図を開く

アプリケーションアクティベーション参照先：

• この図は、アプリケーションがアクティブになったイベントを参照します。

チャットオープニング：

• アプリユーザーはチャットを開き、UIはconnect()との接続を開始します。

• チャットの状態がチェックされます：

  • 接続する場合、SDKはWebSocket接続を確立します。

  • 初期または準備中の場合、IllegalChatStateErrorが返されます。

  • 準備されていれば、チャットモードがチェックされます：

    • ライブチャットおよびライブチャットのステータスがオフラインの場合、チャットの状態はofflineに設定されます。

    • そうでない場合は、WebSocket接続が確立されます。

    • OAuth対応は有効か無効かによって異なります。

OAuth対応：

• OAuthが有効の場合：

  • SDKはreconnectCustomerEventData(accessToken:)に再接続します。

  • サーバー エラーがあれば、それは処理される。

  • そうでなければ、CustomerReconnectedEventが受信されます。

• OAuthが無効の場合：

  • SDKはauthorizeCustomerEventData(authorizationCode:codeVerifier:)で認証されます。

  • サーバー エラーがあれば、それは処理される。

  • そうでない場合、CustomerAuthorizedEventが受信され、アクセストークンと顧客アイデンティティーが保存されます。

チャット接続状態：

• チャットの状態はconnectedに設定されています。

• UIはonChatUpdated()で通知されます。

• チャットがシングル シングルスレッドのアプリでは、各コンタクトに1つのチャットスレッドが割り当てられ、その組織とのあらゆるインタラクションを処理します。かマルチスレッド マルチスレッドのアプリでは、コンタクトは新しいトピックについて議論するために、好きなだけスレッドを作成できます。 これらのスレッドは同時にアクティブにすることができます。かに応じて、関連するチャットビューが表示されます。

新しいウィンドウで図を開く

アプリケーションアクティベーション参照先：

• この図は、オープンチャッ・イベントを参照しています。

スレッドリカバリー：

• SDKはローカルストレージからスレッドIDをロードします。

• 外部プラットフォームからのスレッドIDがローカルに保存される場合、SDKはRecoverMessagingThreadEvent(threadId:)を使用してメッセージングスレッドを復元します。

• UUIDが利用可能でない場合、SDKはRecoverMessagingThreadEvent(nil)での回復を試行します。

スレッド存在チェック：

• スレッドが存在する場合、ThreadRecoveredEventが受信されます。

  • チャットとスレッドの状態はreadyに設定されています。

  • UIはonThreadUpdated()で通知されます。

• スレッドが存在しない場合は、ThreadRecoverFailedEventが受信されます。

  • チャットの状態が準備中に設定されます。

  • UIはonChatUpdated()で通知されます。

  • 注記は、スレッドリカバリーが不要であることを示します。

チャットインタラクション：

• UIは、ユーザーがエージェントとエンゲージするためのチャットウィンドウを表示します。

新しいウィンドウで図を開く

アプリケーションアクティベーション参照先：

• この図は、オープンチャッ・イベントを参照しています。

スレッドリスト検索：

• SDKは、FetchThreadListEventを使用してバックエンドからスレッドのリストをフェッチします。

• サーバー エラーがあれば、それは処理される。

• そうでない場合は、スレッドリストがフェッチされます。

スレッド処理：

• スレッドが存在する場合：

  • SDKは各スレッドの状態をreceivedに設定し、最後のメッセージをロードします。

  • スレッドのメタデータがロードされ、状態がloadedに設定されます。

  • チャットの状態はreadyに設定され、UIは通知されます。

• スレッドが存在しない場合：

  • チャットの状態はreadyに設定され、UIは通知されます。

スレッドを作成またはオープン：

• 新しいスレッドを作成する場合：

  • ユーザーがスレッド作成を開始します。

• 既存のスレッドを開く場合：

  • ユーザーはスレッドを選択します。

  • UIはopenThread(thread:)を使ってスレッドを開きます。

  • スレッドはバックエンドから回復されます。

  • サーバーエラーがあれば、それは処理されます。

  • そうでなければ、スレッドは回復し、状態はreadyに設定されます。

チャットインタラクション：

• ユーザーはエージェントとのチャットにエンゲージします。

新しいウィンドウで図を開く

ユーザー詳細とプレチャット：

• 顧客名が提供されない場合、UIはユーザー詳細フォームビューを表示します。

• プレチャット情報が利用可能な場合、UIはプレチャットフォームビューを表示します。

スレッド作成：

• ユーザーは会話を始めます。

• UIは、createThread(customFields:)を使ってスレッドの作成を開始します。

• チャットモードがマルチスレッドでなく、スレッドがすでに存在する場合：

  • unsupportedChannelConfigErrorが返されます。

  • エラーアラートが表示されます。

• そうでない場合：

  • SDKはUUIDでローカルにスレッドを作成します。

  • UUIDはローカルに保存されます。

  • スレッドの状態はpendingに設定されます。

  • UIはonThreadUpdated()で通知されます。

新しいウィンドウで図を開く

チャット初期化：

• ユーザーは sendMessage(message:)を使ってメッセージを送信します。

• ウェルカムメッセージが利用可能の場合：

  • SDKは、SendOutboundMessageEvent(welcomeMessage:)を使用してアウトバウンドウェルカムメッセージを送信します。

  • サーバー エラーがあれば、それは処理される。

  • そうでない場合、MessageCreatedEventが受信され、UIが更新されます。

• SDKは、sendMessageEventを使ってユーザーのメッセージを送信します。

  • サーバー エラーがあれば、それは処理される。

  • そうでない場合、MessageCreatedEventが受信され、UIが更新されます。

新しいウィンドウで図を開く

チャット終了：

• ユーザーは会話の終了を押します。

• UIは、endConversation()を使用してSDKに会話の終了を通知します。

• バックエンドはEndConversationEventを受信します。

  • サーバー エラーがあれば、それは処理される。

  • そうでない場合、ケースのステータスは変更され、スレッドの状態はclosedに設定されます。

  • UIはonThreadUpdated()で通知されます。

エンドコンタクトエクスペリエンスビュー：

• UIはエンドコンタクトビューを表示します。