NowChatOptions: Android

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:5分
  • NowChatOptions クラスを使用すると、チャット ウィンドウを閉じる前にプロンプトを表示したり、チャットの使用中に機能を無効にしたり、チャット サービスの開始時に新しいチャット会話を強制したりするなど、チャット セッションのオプションを構成できます。

    NowChatOptions - NowChatOptions(closePrompt: ClosePrompt?, disabledFeatures: List<Feature>?, forceNewConversation: Boolean?)

    現在のチャットセッションのオプションを設定します。このメソッドを使用すると、チャットウィンドウを閉じる前にプロンプトを表示したり、チャットの使用中に機能を無効にしたり、チャットサービスの開始時に新しいチャット会話を強制したりできます。

    表 : 1. パラメーター
    名前 タイプ Description (説明)
    closePrompt ClosePrompt オブジェクト 関連するチャットウィンドウを閉じる前に表示するプロンプト。

    クローズプロンプトを表示したくない場合は、nullを渡します。

    disabledFeatures List<NowChatOptions.Feature> 現在のチャットセッション内で無効にするチャット機能のリスト。
    有効な値:
    • START_NEW_CONVERSATION:チャットウィンドウに表示される [新しい会話 を開始] ボタンを非表示/無効にします。

    使用可能なチャット機能は、 NowChatOptions.Feature 列挙型クラスで定義されています。

    どの機能も無効にしたくない場合は、nullを渡します。

    forceNewConversation ブーリアン チャットセッションの開始時に新しいチャット会話を強制するかどうかを示すフラグ。現在の会話はすべてクローズされます。
    有効な値:
    • true:新しいチャット会話を開始します。新しいチャットウィンドウが開きます。
    • false:新しいチャット会話を開始しません。前のチャット会話の内容をロードします。

    デフォルト値:false

    表 : 2. 返される内容
    タイプ Description (説明)
    チャットオプション NowChatService - start(activity: Activity, themeColors: NowChatTheme = object : NowChatTheme{}, contextData: map<String, Any> = mapOf(), chatOptions: NowChatOptions? = null) メソッドで渡すことができる chatOptions オブジェクトを返します。

    次のコード例は、このメソッドを呼び出す方法を示しています。

    suspend fun launchChat() { 
      val chatService = getNowChatService() 
      val chatTheme = object : NowChatTheme { 
        override val brand: NowUIAdaptiveColor 
        get() = NowUIAdaptiveColor(Color.BLUE) 
     
        override val textPrimary: NowUIAdaptiveColor 
        get() = NowUIAdaptiveColor(Color.BLACK) 
     
        // Override remaining theme colors 
     
      } 
      val contextData = mapOf("sys_id" to "123456789", "table" to "wm_task") 
     
      val chatOptions = NowChatOptions( 
        NowChatOptions.ClosePrompt( 
          header = null, 
          message = "Are you sure you want to leave?", 
          acceptButtonTitle = "Yes", 
          declineButtonTitle = "No" 
        ), 
        disabledFeatures = listOf(NowChatOptions.Feature.START_NEW_CONVERSATION), 
        forceNewConversation= true 
      )
     
       chatService?.start(activity, chatTheme, contextData, chatOptions) 
    } 

    NowChatOptions - ClosePrompt(header: String, message: String, acceptButtonTitle: String, declineButtonTitle: String)

    渡されたパラメーターに基づいて ClosePrompt オブジェクトを作成して返します。次に、このオブジェクトを NowChatOptions() メソッドに渡して、チャットセッション内のプロンプトを閉じるオプションを設定します。

    表 : 3. パラメーター
    名前 タイプ 説明
    header 文字列 プロンプトのヘッダーに表示するテキスト。

    プロンプトヘッダーを表示しない場合は、nullを渡します。

    メッセージ 文字列 プロンプトのメインテキストとして表示するテキスト。
    acceptButtonTitle 文字列 チャットウィンドウを閉じるためにプロンプトのプライマリボタンに表示するテキスト。
    拒否ボタンのタイトル 文字列 プロンプトを却下するためにプロンプトのセカンダリボタンに表示するテキスト。

    セカンダリボタンを表示したくない場合は、nullを渡します。

    次のコード例は、このメソッドを呼び出す方法を示しています。

    suspend fun launchChat() { 
      val chatService = getNowChatService() 
      val chatTheme = object : NowChatTheme { 
        override val brand: NowUIAdaptiveColor 
        get() = NowUIAdaptiveColor(Color.BLUE) 
     
        override val textPrimary: NowUIAdaptiveColor 
        get() = NowUIAdaptiveColor(Color.BLACK) 
     
        // Override remaining theme colors 
     
      } 
      val contextData = mapOf("sys_id" to "123456789", "table" to "wm_task") 
     
      val chatOptions = NowChatOptions( 
        NowChatOptions.ClosePrompt( 
          header = null, 
          message = "Are you sure you want to leave?", 
          acceptButtonTitle = "Yes", 
          declineButtonTitle = "No" 
        ), 
        disabledFeatures = listOf(NowChatOptions.Feature.START_NEW_CONVERSATION), 
        forceNewConversation= true 
      )
     
       chatService?.start(activity, chatTheme, contextData, chatOptions) 
    }