Classe NowPushService - Android

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 2 min. de leitura
  • A classe NowPushService fornece funções que permitem a interação com o serviço de notificação por push.

    Tabela 1. Propriedades
    Nome Descrição
    configuração Configuração de serviço a ser associada ao serviço.

    Tipo de dados: NowServiceConfiguration

    NowPushService - handlePush(remoteMessage: RemoteMessage, sucessoCallback: consumidor<NowPushPayload> , errorCallback: consumidor<Throwable> )

    Processa uma solicitação de notificação por push.

    Nota:
    Atualmente, o único tipo de notificação por push implementado é NowPushVirtualAgent. Qualquer outro tipo de notificação por push aprovado retorna um objeto NotSupportedPushError.
    Tabela 2. Parâmetros
    Nome Tipo Descrição
    Mensagem remota Mensagem remota Notificação recebida por com.google.firebase.messaging.FirebaseMessagingService.onMessageReopened . Para obter informações adicionais, consulte Como receber mensagens em um aplicativo para Android.
    sucesso no retorno de chamada Consumidor <NowPushPayload> Retorno de chamada para retornar o processado NowPushPayload para.
    erro de retorno de chamada Consumidor <Throwable> Retorno de chamada para retornar o erro gerado. Se o erro NotSupportedPushError for lançado, o tipo de notificação não será compatível com o SDK para celular e deverá ser processado fora da estrutura do SDK para celular.
    Tabela 3. Retornos
    Tipo Descrição
    Nenhum(a)

    Este exemplo mostra como substituir onMessageReceived() e passar o RemoteMessage por meio de para o NowPushService. Se o NowPushService reconhecer o tipo de notificação, ele processará a solicitação e retornará o objeto de notificação para a aplicação processar. Caso contrário, ele emitirá o NotSupportedPushError.

    override fun onMessageReceived(remodeeMessage: RemoteMessage){
      pushService.handlePush(remoteMessage, { push ->
        when (push) {
          is NowPushVirtualAgent → handleVirtualAgentPush(push)
        }, { error ->
            Log.e(TAG, "Unknown push", error)
            handleAppPushNotification(remoteMessage)
        })
    }

    NowPushService - registerPushToken(pushToken: cadeia de caracteres, pushApp: cadeia de caracteres, sucessoCallback: executável, errorCallback: consumidor<Throwable> )

    Registra um token Firebase exclusivo com a instância ServiceNow usada para identificar as notificações por push do dispositivo Android atual e da aplicação especificada.

    Para que a instância ServiceNow gere notificações, o dispositivo Android receba notificações da aplicação, este token deve ser registrado.

    Tabela 4. Parâmetros
    Nome Tipo Descrição
    pushToken Cadeia de caracteres Firebase token recuperado por com.google.firebase.messaging.FirebaseMessaging.getToken ou com.google.firebase.messaging.FirebaseMessagingService.onNewToken.
    pushApp Cadeia de caracteres Nome da aplicação de envio conforme especificado na tabela Aplicação de envio na instância ServiceNow associada.
    sucesso no retorno de chamada Executável Retorno de chamada executado quando o registro do token é bem-sucedido.
    erroRetorno de chamada Consumidor <Throwable> Retorno de chamada executado quando o registro do token falha.
    Tabela 5. Retornos
    Tipo Descrição
    Nenhum(a)

    Este exemplo registra um token de envio para o dispositivo Android atual e a aplicação "PushAppName".

    FirebaseMessaging.getInstance().token.addOnCompleteListener { task ->
      val token = task.result
    
      if (!task.isSuccessful || token == null) {
        throw Exception("Unable to fetch token"))
      }
    
      pushService.registerPushToken(token, "PushAppName", {
        Log.v(TAG, "Successfully registered push token")
      }, { e ->
        Log.e(TAG, "Error registering push", e)
      })
    }

    NowPushService - unregisterPushToken(pushToken: cadeia de caracteres, pushApp: cadeia de caracteres, sucessoCallback: executável, errorCallback: consumidor<Throwable> )

    Cancela o registro do token de push Firebase especificado com a instância ServiceNow associada.

    Tabela 6. Parâmetros
    Nome Tipo Descrição
    pushToken Cadeia de caracteres Firebase token para cancelar o registro. Recuperado por com.google.firebase.messaging.FirebaseMessaging.getToken ou com.google.firebase.messaging.FirebaseMessagingService.onNewToken.
    pushApp Cadeia de caracteres Nome da aplicação de envio por push associada ao token para cancelar o registro. Essas informações são armazenadas na tabela Aplicação de push na instância associada ServiceNow.
    sucesso no retorno de chamada Executável Retorno de chamada executado quando o cancelamento do registro do token é bem-sucedido.
    erro rCallback Consumidor <Throwable> Retorno de chamada executado quando há falha no cancelamento do registro do token.
    Tabela 7. Retornos
    Tipo Descrição
    Nenhum(a)

    Este exemplo de código mostra como cancelar o registro de um token de envio, como quando o usuário faz logout da aplicação.

    pushService.unregisterPushtoken(token, "PushAppName", {
      Log.v(TAG, "Successfully unregistered push token")
    },  { e ->
      Log.e(TAG, "Error unregistering push", e)
    })