NowChatOptions - Android

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 2 min. de leitura
  • A classe NowChatOptions 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 e forçar uma nova conversa de bate-papo quando o serviço de bate-papo for iniciado.

    NowChatOptions - NowChatOptions(closePrompt: ClosePrompt?, disableFeatures: lista<Feature> ?, forceNewConversation: booliano?)

    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 e force uma nova conversa de bate-papo quando o serviço de bate-papo for iniciado.

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

    Se você não quiser exibir um aviso de fechamento, passe nulo.

    desabilitadosRecursos Lista<NowChatOptions.Feature> 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 NowChatOptions.Feature.

    Se você não quiser desabilitar nenhum recurso, passe nulo.

    forçaNovaConversa Booliano Sinalizador que indica se uma nova conversa de bate-papo deve ser forçada quando a sessão de bate-papo for iniciada. Todas as conversas atuais são encerradas.
    Valores válidos:
    • verdadeiro: iniciar uma nova conversa de bate-papo; uma nova janela de bate-papo é aberta.
    • falso: não inicia uma nova conversa de bate-papo; carrega o conteúdo da conversa de bate-papo anterior.

    Padrão: falso

    Tabela 2. Retorna
    Tipo Descrição
    chatOpções Retorna um objeto chatOptions que você pode passar no método NowChatService - start(activity: Activity,meColors: NowChatTheme = objeto : NowChatTheme{}, contextData: Map<String, Any> = mapOf(), chatOptions: NowChatOptions? = nulo).

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

    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 (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 NowChatOptions() para configurar as opções de aviso de fechamento em uma sessão de bate-papo.

    Tabela 3. 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.

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

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