NowChatConfiguration - Android

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 5 min. de leitura

    • A classe NowChatConfiguration permite que você configure opções em uma sessão de bate-papo, como mostrar um aviso 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? = nulo, disableFeatures: Lista<Feature> ? = nulo, conversationOptions: lista<ConversationOption> ? = nulo, uiConfiguration: UIConfiguration? = nulo)

    Configura opções para a sessão de bate-papo atual. Este método permite que você mostre um aviso antes de fechar uma janela de bate-papo, desabilite recursos ao usar o bate-papo, aplique diferentes opções de conversa ao usar o bate-papo e configure componentes de IU no NowChat.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    fecharPrompt ObjetoClosePrompt Aviso a ser exibido antes de fechar a janela de bate-papo associada.

    Chame a subclasse NowChatConfiguration.ClosePrompt() 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 aviso de fechamento, passe nulo.
    desabilitadosRecursos Lista

    Recurso>

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

    Valor válido:

    START_NEW_CONVERSATION: oculte/desabilite o botão Iniciar nova conversa que aparece em uma janela de bate-papo.

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

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

    Se você não quiser desabilitar nenhum recurso, passe nulo.
    conversaOpções Lista

    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 na classe de enumeração NowChatConfiguration.ConversationOption.

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

    Se você não quiser aplicar nenhuma opção, passe nulo.
    iuConfiguration UIConfiguration? Valores de UIConfiguration a serem usados para configurar componentes de IU no NowChat.
    Valores válidos:
    • attachmentUploadButton: configuração do AttachmentUploadButton que é mostrado ao lado da entrada de texto ao falar com um atendente.
    • closeButton: configuração do CloseButton usado para navegação de retorno 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 o método NowChatService - start(activity: Activity,meColors: NowChatTheme = objeto: NowChatTheme{}, contextData: Map<String, Any> = mapOf(), chatConfiguration: NowChatConfiguration? = nulo).

    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: booliano = verdadeiro)

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

    AttachmentUploadButton é uma subclasse da classe NowChatConfiguration.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    IsVisible Booliano Sinalizador que indica a visibilidade do botão de 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: desenhável?)

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

    CloseButton() é uma subclasse da classe NowChatConfiguration.

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

    Você pode usar o método ContextCompat.getDrawable() para obter este objeto desenhável.

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

    Para usar o desenhável padrão, passe nulo.

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

    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, recusaButtonTitle: cadeia de caracteres)

    Cria e retorna um objeto ClosePrompt com base nos parâmetros passados. Em seguida, você passa este objeto para o método NowChatConfiguration() 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 o texto principal do prompt.
    aceitarBotãoTítulo Cadeia de caracteres Texto a ser exibido no botão primário do prompt para fechar a janela de bate-papo.
    recusarTítuloDoBotão Cadeia de caracteres Texto a ser exibido no botão secundário do prompt que descarta 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? = nulo, attachmentUploadButton: AttachmentUploadButton? = nulo)

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

    UIConfiguration é uma subclasse da classe NowChatConfiguration.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    botãoFechar BotãoFechar? Configuração do CloseButton que aparece na barra de ferramentas do NowChat e é usada para navegação de retorno.

    Chame a subclasse NowChatConfiguration - CloseButton (ícone: desenhável?) 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 que é mostrado ao lado da entrada de texto durante a conversa com um atendente.

    Chame a subclasse NowChatConfiguration - AttachmentUploadButton (isVisible: booliano = verdadeiro) 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 a subclasse UIConfiguration 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) 
}