NowChatConfiguration クラス : Android

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：13分

    • NowChatConfiguration クラスを使用すると、チャットウィンドウを閉じる前のプロンプトの表示、チャットの使用中の機能の無効化、チャットの使用中のさまざまな会話オプションの適用、NowChat での UI コンポーネントの構成など、チャットセッションのオプションを構成できます。

    NowChatConfiguration - NowChatConfiguration(closePrompt: ClosePrompt? = null, disabledFeatures: List<Feature>? = null, conversationOptions: List<ConversationOption>? = null, uiConfiguration: UIConfiguration? = null)

    現在のチャットセッションのオプションを構成します。この方法を使用すると、チャットウィンドウを閉じる前にプロンプトを表示したり、チャットの使用中に機能を無効にしたり、チャットの使用中にさまざまな会話オプションを適用したり、NowChat の UI コンポーネントを構成したりできます。

    表 : 1. パラメーター
    名前 タイプ 説明
    プロンプトを閉じる ClosePrompt オブジェクト 関連付けられたチャットウィンドウを閉じる前に表示されるプロンプト。

    NowChatConfiguration.ClosePrompt() サブクラスを呼び出して、このパラメーターの値を定義します。

    例：
    closePrompt = NowChatConfiguration.ClosePrompt(
  header = null,
  message = "Are you sure you want to leave?",
  acceptButtonTitle = "Yes",
  declineButtonTitle = "No"
)

    クローズプロンプトを表示しない場合は、null を渡します。
    無効な機能 List<NowChatConfiguration。

    機能>

    		 現在のチャットセッション内で無効にするチャット機能のリスト。

    有効な値:

    START_NEW_CONVERSATION:チャットウィンドウに表示される [会話を新規に開始 ] ボタンを非表示/無効にします。

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

    例：
    disabledFeatures = listOf(NowChatConfiguration.Feature.START_NEW_CONVERSATION)

    機能を無効にしない場合は、null を渡します。
    conversationOptions リスト<会話

    オプション>?

    		 NowChat に適用する会話オプションのリスト。
    有効な値：
    • END_CONVERSATION_ON_EXIT:NowChat ウィンドウを終了すると、進行中の会話が終了します。
    • FORCE_NEW_CONVERSATION:NowChat の開始時に新しいチャット会話を強制します。

    使用可能な会話オプションは、 NowChatConfiguration.ConversationOption 列挙型クラスで定義されます。

    例：
    conversationOptions = listOf(NowChatConfiguration.ConversationOption.FORCE_NEW_CONVERSATION),

    オプションを適用しない場合は、null を渡します。
    UI 構成 UIConfiguration? NowChat で UI コンポーネントを構成するために使用する UIConfiguration 値。
    有効な値：
    • attachmentUploadButton:ライブエージェントとの会話中にテキスト入力の横に表示される AttachmentUploadButton の構成。
    • closeButton:NowChat ツールバーの戻るナビゲーションに使用される CloseButton の構成。
    例：
    uiConfiguration = NowChatConfiguration.UIConfiguration(
  closeButton = NowChatConfiguration.CloseButton(
    icon = myDrawable
  ),
  attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
)

    デフォルト構成を使用するには、null を渡します。
    表 : 2. 返される内容
    タイプ 説明
    NowChat 構成 NowChatService - start(activity: Activity, themeColors: NowChatTheme = object: NowChatTheme{}, contextData: map<String, Any> = mapOf(), chatConfiguration: NowChatConfiguration? = null) メソッドを呼び出すときに渡すことができる NowChatConfiguration オブジェクトを返します。

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

    suspend fun launchChat() {
  val chatService = getNowChatService()
 
  //Drawable to use instead of the default NowChat back button.
  val myDrawable = ContextCompat.getDrawable(activity, R.drawable.my_drawable)
     
  val chatConfiguration = NowChatConfiguration(
    closePrompt = NowChatConfiguration.ClosePrompt(
      header = null,
      message = "Are you sure you want to leave?",
      acceptButtonTitle = "Yes",
      declineButtonTitle = "No"
    ),
    disabledFeatures = listOf(NowChatConfiguration.Feature.START_NEW_CONVERSATION),
    conversationOptions = listOf(NowChatConfiguration.ConversationOption.FORCE_NEW_CONVERSATION),
    uiConfiguration = NowChatConfiguration.UIConfiguration(
      closeButton = NowChatConfiguration.CloseButton(
        icon = myDrawable
      ),
      attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
    )
  )

  chatService?.start(activity, chatConfiguration)
}

    NowChatConfiguration - AttachmentUploadButton(isVisible: ブール = true)

    ライブエージェントとの会話中にテキスト入力の横に表示される [添付ファイルをアップロード] ボタンに適用する UI 構成を定義します。

    AttachmentUploadButton は NowChatConfiguration クラスのサブクラスです。

    表 : 3. パラメーター
    名前 タイプ 説明
    isVisible ブーリアン [添付ファイルをアップロード] ボタンのヴィジビリティを示すフラグ。
    有効な値：
    • true:[添付ファイルをアップロード] ボタンが表示されます。
    • false:[添付ファイルをアップロード] ボタンは非表示です。

    デフォルト：true
    表 : 4. 返される内容
    タイプ 説明
    オブジェクト UI 構成オブジェクト。

    次のコード例は、AttachmentUploadButton を非表示にする方法を示しています。

    suspend fun launchChat() {
  val chatService = getNowChatService()

  val chatConfiguration = NowChatConfiguration(
    uiConfiguration = NowChatConfiguration.UIConfiguration(
      attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
    )
  )
 
  chatService?.start(activity, chatConfiguration)
}

    NowChatConfiguration - CloseButton(アイコン:ドローアブル?)

    NowChat ツールバーの戻るナビゲーションに使用する閉じるボタンの構成を定義します。次に、このオブジェクトを NowChatConfiguration() メソッドに渡して、チャットセッション内で使用する [閉じる] ボタンを構成します。

    CloseButton() は NowChatConfiguration クラスのサブクラスです。

    表 : 5. パラメーター
    名前 タイプ 説明
    icon 描画可能? 閉じる (戻る) ボタンに使用する描画可能なオブジェクト。

    ContextCompat.getDrawable() メソッドを使用して、このドローアブルオブジェクトを取得できます。

    例：
    val myDrawable = ContextCompat.getDrawable(activity, R.drawable.my_drawable)

    デフォルトのドローアブルを使用するには、null を渡します。

    デフォルト:NowChat の [戻る] ボタン
    表 : 6. 返される内容
    タイプ 説明
    オブジェクト [閉じる] ボタンの構成オブジェクト。

    次のコード例は、NowChat ツールバーの閉じるボタンのカスタムアイコンを設定する方法を示しています。

    suspend fun launchChat() {
  val chatService = getNowChatService()
 
  //Drawable to use instead of the default NowChat back button.
  val myDrawable = ContextCompat.getDrawable(activity, R.drawable.my_drawable)

  val chatConfiguration = NowChatConfiguration(
    uiConfiguration = NowChatConfiguration.UIConfiguration(
      closeButton = NowChatConfiguration.CloseButton(
        icon = myDrawable
      )
    )
  )

  chatService?.start(activity, chatConfiguration)
}

    NowChatConfiguration - ClosePrompt(header:文字列、メッセージ:文字列、acceptButtonTitle:文字列、declineButtonTitle:文字列)

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

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

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

    セカンダリボタンを表示しない場合は、null を渡します。
    表 : 8. 返される内容
    タイプ 説明
    オブジェクト 関連付けられたチャットウィンドウを閉じる前に表示されるプロンプト。

    次のコード例は、このメソッドを呼び出してクローズプロンプトを構成する方法を示しています。

    suspend fun launchChat() {
  val chatService = getNowChatService()
 
  val chatConfiguration = NowChatConfiguration(
    closePrompt = NowChatConfiguration.ClosePrompt(
      header = null,
      message = "Are you sure you want to leave?",
      acceptButtonTitle = "Yes",
      declineButtonTitle = "No"
    )
  )
  chatService?.start(activity, chatConfiguration)
}

    NowChatConfiguration - UIConfiguration(closeButton: CloseButton? = null, attachmentUploadButton: AttachmentUploadButton? = null)

    渡されたパラメーターに基づいて UIConfiguration オブジェクトを作成して返します。次に、このオブジェクトを NowChatConfiguration() コンストラクターに渡して、NowChat で UI コンポーネントを構成します。

    UIConfiguration は NowChatConfiguration クラスのサブクラスです。

    表 : 9. パラメーター
    名前 タイプ 説明
    閉じるボタン 閉じるボタン? NowChat ツールバーに表示され、戻るナビゲーションに使用される CloseButton の構成。

    NowChatConfiguration - CloseButton(アイコン:ドローアブル?) サブクラスを呼び出して、このパラメーターの値を定義します。

    例：
    val chatConfiguration = NowChatConfiguration( 
  uiConfiguration = NowChatConfiguration.UIConfiguration( 
    closeButton = NowChatConfiguration.CloseButton( 
      icon = myDrawable
  )
)
    添付ファイルアップロードボタン AttachmentUploadButton? ライブエージェントとの会話中にテキスト入力の横に表示される AttachmentUploadButton の構成。

    NowChatConfiguration - AttachmentUploadButton(isVisible: ブール = true) サブクラスを呼び出して、このパラメーターの値を定義します。

    例：
    val chatConfiguration = NowChatConfiguration( 
  uiConfiguration = NowChatConfiguration.UIConfiguration(
    attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
  ) 
)
    表 : 10. 返される内容
    タイプ 説明
    オブジェクト UI 構成オブジェクト。

    次のコード例は、 UIConfiguration サブクラスを呼び出して closeButton のアイコンを設定し、添付ファイルのアップロードボタンを非表示にする方法を示しています。

    suspend fun launchChat() {
  val chatService = getNowChatService() 
     
  //Drawable to use instead of the default NowChat back button. 
  val myDrawable = ContextCompat.getDrawable(activity, R.drawable.my_drawable) 
 
  val chatConfiguration = NowChatConfiguration( 
    uiConfiguration = NowChatConfiguration.UIConfiguration( 
      closeButton = NowChatConfiguration.CloseButton( 
        icon = myDrawable 
      ), 
      attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
    ) 
  ) 
 
  chatService?.start(activity, chatConfiguration) 
}