NowChatConfiguration - Android

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 5 min. de leitura

    • . NowChatConfiguration A classe permite que você configure opções em uma sessão de bate-papo, como mostrar um prompt antes de fechar uma janela de bate-papo, desabilitar recursos ao usar o bate-papo, aplicar diferentes opções de conversa ao usar o bate-papo e configurar componentes de IU no NowChat.

    NowChatConfiguration - NowChatConfiguration(closePrompt: ClosePrompt? DisabledFeatures: List<Feature>? ConversationOptions: List<ConversationOption>? UIConfiguration: UIConfiguration? nulo)

    Configura opções para a sessão de bate-papo atual. Este método permite mostrar um prompt antes de fechar uma janela de bate-papo, desabilitar recursos ao usar o bate-papo, aplicar diferentes opções de conversa ao usar o bate-papo e configurar componentes de IU no NowChat.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    PróximoPrompt EncerraPrompt objeto Aviso a ser exibido antes de fechar a janela de bate-papo associada.

    Ligue para NowChatConfiguration.ClosePrompt() subclasse para definir o valor deste parâmetro.

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

    Se você não quiser exibir um prompt de fechamento, passe nulo.
    DesabilitadosFeatures NowChatConfiguration.

    Recurso>

    		 Lista de recursos de bate-papo a serem desativados na sessão de bate-papo atual.

    Valor válido:

    START_NEW_CONVERSATION: Oculta/desabilita o. Iniciar Nova conversa botão que aparece em uma janela de bate-papo.

    Os recursos de bate-papo disponíveis são definidos em NowChatConfiguration.recurso classe de enumeração.

    Por exemplo:
    disabledFeatures = listOf(NowChatConfiguration.Feature.START_NEW_CONVERSATION)

    Se você não quiser desabilitar nenhum recurso, passe para nulo.
    ConversationOptions Lista > conversa

    Opção>?

    		 Lista de opções de conversa a serem aplicadas ao NowChat.
    Valores válidos:
    • END_CONVERSATION_ON_EXIT: A conversa em andamento é encerrada ao sair da janela do NowChat.
    • FORCE_NEW_CONVERSATION: Força uma nova conversa de bate-papo quando o NowChat é iniciado.

    As opções de conversa disponíveis são definidas em NowChatConfiguration.ConversationOption classe de enumeração.

    Por exemplo:
    conversationOptions = listOf(NowChatConfiguration.ConversationOption.FORCE_NEW_CONVERSATION),

    Se você não quiser aplicar nenhuma opção, passe nulo.
    UIConfiguration UIConfiguration? Valores UIConfiguration a serem usados para configurar componentes de IU no NowChat.
    Valores válidos:
    • attachmentUploadButtonConfiguração do AttachmentUploadButton mostrado ao lado da entrada de texto durante a conversa com um atendente.
    • closeButtonConfiguração do Encerrar botão Usado para navegação anterior na barra de ferramentas do NowChat.
    Por exemplo:
    uiConfiguration = NowChatConfiguration.UIConfiguration(
  closeButton = NowChatConfiguration.CloseButton(
    icon = myDrawable
  ),
  attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
)

    Para usar a configuração padrão, passe nulo.
    Tabela 2. Retornos
    Tipo Descrição
    NowChatConfiguration Retorna um objeto NowChatConfiguration que você pode passar ao chamar NowChatService - start(activity: Activity, themeCores: NowChatTheme, contextData: Map<String, Any> mapOf(), chatConfiguration: NowChatConfiguration? nulo) método.

    O exemplo de código a seguir mostra como chamar este método.

    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: Boolian

    Define as configurações de IU a serem aplicadas ao botão Carregar anexo que aparece ao lado da entrada de texto ao conversar com um atendente.

    AttachmentUploadButton é uma subclasse de NowChatConfiguration classe.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    IsVisible Booliano Sinalizador que indica a visibilidade do botão Carregar anexo.
    Valores válidos:
    • Verdadeiro: O botão Carregar anexo está visível.
    • Falso: O botão Carregar anexo está oculto.

    Padrão: verdadeiro
    Tabela 4. Retornos
    Tipo Descrição
    Objeto Objeto de configuração de IU.

    O exemplo de código a seguir mostra como ocultar o AttachmentUploadButton.

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

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

    NowChatConfiguration - CloseButton(ícone: Drawable?)

    Define a configuração do botão Fechar usado para navegação de volta na barra de ferramentas do NowChat. Em seguida, você passa este objeto para NowChatConfiguration() método para configurar o botão fechar para usar na sessão de bate-papo.

    CloseButton() é uma subclasse de NowChatConfiguration classe.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    ícones Drawable? Objeto desenhável a ser usado para o botão Fechar (Voltar).

    Você pode usar ContextCompat.getDrawable() método para obter este objeto drawable.

    Por exemplo:
    val myDrawable = ContextCompat.getDrawable(activity, R.drawable.my_drawable)

    Para usar o drawable padrão, passe nulo.

    Botão Voltar NowChat
    Tabela 6. Retornos
    Tipo Descrição
    Objeto Fechar objeto de configuração do botão.

    O exemplo de código a seguir mostra como definir um ícone personalizado para o botão Fechar na barra de ferramentas do 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(cabeçalho: Cadeia de caracteres, mensagem: Cadeia de caracteres, acceptButtonTitle: Cadeia de caracteres, declineButtonTitle: Cadeia de caracteres)

    Cria e retorna um objeto ClosePrompt com base nos parâmetros aprovados. Em seguida, você passa este objeto para NowChatConfiguration() método para configurar as opções de aviso de fechamento na sessão de bate-papo.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    cabeçalho Cadeia de caracteres Texto a ser exibido no cabeçalho do prompt.

    Se você não quiser exibir um cabeçalho de prompt, passe nulo.
    mensagem Cadeia de caracteres Texto a ser exibido como texto principal do prompt.
    AcceptButtonTitle Cadeia de caracteres Texto a ser exibido no botão primário do prompt para fechar a janela de bate-papo.
    DeclineButtonTitle Cadeia de caracteres Texto a ser exibido no botão secundário do prompt que ignora o prompt.

    Se você não quiser exibir um botão secundário, passe nulo.
    Tabela 8. Retornos
    Tipo Descrição
    Objeto Aviso a ser exibido antes de fechar a janela de bate-papo associada.

    O exemplo de código a seguir mostra como chamar este método para configurar o prompt de fechamento.

    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? AttachmentUploadButton: AttachmentUploadButton? nulo)

    Cria e retorna um objeto UIConfiguration com base nos parâmetros passados. Em seguida, você passa este objeto para NowChatConfiguration() Construtor para configurar componentes de IU no NowChat.

    UIConfiguration é uma subclasse de NowChatConfiguration classe.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    CloseButton CloseButton? Configuração do Encerrar botão Que aparece na barra de ferramentas do NowChat e é usado para navegação de volta.

    Ligue para NowChatConfiguration - CloseButton(ícone: Drawable?) subclasse para definir o valor deste parâmetro.

    Por exemplo:
    val chatConfiguration = NowChatConfiguration( 
  uiConfiguration = NowChatConfiguration.UIConfiguration( 
    closeButton = NowChatConfiguration.CloseButton( 
      icon = myDrawable
  )
)
    AttachmentUploadButton AttachmentUploadButton? Configuração do AttachmentUploadButton mostrado ao lado da entrada de texto durante a conversa com um atendente.

    Ligue para NowChatConfiguration - AttachmentUploadButton(isVisible: Boolian subclasse para definir o valor deste parâmetro.

    Por exemplo:
    val chatConfiguration = NowChatConfiguration( 
  uiConfiguration = NowChatConfiguration.UIConfiguration(
    attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
  ) 
)
    Tabela 10. Retornos
    Tipo Descrição
    Objeto Objeto de configuração de IU.

    O exemplo de código a seguir mostra como chamar UIConfiguration Subclasse para definir o ícone do closeButton e ocultar o botão de carregamento de anexo.

    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) 
}