NowPushService-Klasse – Android

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 2 Minuten Lesedauer
  • Die Klasse NowPushService stellt Funktionen bereit, die die Interaktion mit dem Push-Benachrichtigungsservice ermöglichen.

    Tabelle : 1. Eigenschaften
    Name Beschreibung
    konfigurieren Servicekonfiguration, die dem Service zugeordnet werden soll.

    Datentyp: NowServiceConfiguration

    NowPushService – handlePush(remoteMessage: RemoteMessage, erfolgreichCallback: Verbraucher<NowPushPayload> , FehlerRückruf: Verbraucher<Throwable> )

    Verarbeitet eine Push-Benachrichtigungsanforderung.

    Hinweis:
    Derzeit ist NowPushVirtualAgentder einzige implementierte Push-Benachrichtigungstyp. Jeder andere übergebene Push-Benachrichtigungstyp gibt ein NotSupportedPushError -Objekt zurück.
    Tabelle : 2. Parameter
    Name Typ Beschreibung
    Remote-Nachricht Remote-Nachricht Benachrichtigung gemäß Empfang durch com.google.firebase.messaging.FirebaseMessagingService.onMessageReceived. Weitere Informationen finden Sie unter Nachrichten in einer Android-App empfangen.
    erfolgreicher Rückruf Verbraucher <NowPushPayload> Rückruf, um den verarbeiteten NowPushPayload an zurückzugeben.
    Fehler „Rückruf“. Verbraucher <Auswerfbar> Rückruf, um den ausgelösten Fehler an zurückzugeben. Wenn der Fehler NotSupportedPushError ausgelöst wird, wird der Benachrichtigungstyp vom Mobile SDK nicht unterstützt und muss außerhalb des Mobile SDK-Frameworks verarbeitet werden.
    Tabelle : 3. Rückgaben
    Typ Beschreibung
    Keine

    In diesem Beispiel wird gezeigt, wie onMessageReceived() überschrieben und RemoteMessage an NowPushServiceübergeben wird. Wenn NowPushService den Benachrichtigungstyp erkennt, verarbeitet er die Anforderung und gibt das Benachrichtigungsobjekt zurück, damit die Anwendung verarbeiten kann. Andernfalls wird der NotSupportedPushErrorausgelöst.

    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 – registrierenPushToken(pushToken: Zeichenfolge, pushApp: Zeichenfolge, erfolgreichCallback: Ausführbar, errorCallback: Verbraucher<Throwable> )

    Registriert ein eindeutiges Firebase -Token bei der ServiceNow -Instanz, das zur Identifizierung der Push-Benachrichtigungen für das aktuelle Android -Gerät und die angegebene Anwendung verwendet wird.

    Damit die Instanz ServiceNow Benachrichtigungen generieren kann, muss Android das -Gerät registriert sein, um Benachrichtigungen von der Anwendung zu erhalten. Dieses Token muss registriert werden.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    pushToken Zeichenfolge Firebase Token abgerufen von entweder com.google.firebase.messaging.FirebaseMessaging.getToken oder com.google.firebase.messaging.FirebaseMessagingService.onNewToken.
    pushApp Zeichenfolge Name der Push-Anwendung, wie in der Tabelle „Push-Anwendung“ in der zugehörigen Instanz ServiceNow angegeben.
    erfolgreicher Rückruf Ausführbar Rückruf, der ausgeführt wird, wenn die Tokenregistrierung erfolgreich ist.
    Fehler Rückruf Verbraucher <Auswerfbar> Rückruf, der ausgeführt wird, wenn die Tokenregistrierung fehlschlägt.
    Tabelle : 5. Rückgaben
    Typ Beschreibung
    Keine

    In diesem Beispiel wird ein Push-Token für das aktuelle Gerät Android und die Anwendung „PushAppName“ registriert.

    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: Zeichenfolge, pushApp: Zeichenfolge, erfolgreichCallback: Ausführbar, errorCallback: Verbraucher<Throwable> )

    Hebt die Registrierung des angegebenen Firebase -Push-Tokens bei der zugehörigen ServiceNow -Instanz auf.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    pushToken Zeichenfolge Firebase Token zum Aufheben der Registrierung. Wird entweder von com.google.firebase.messaging.FirebaseMessaging.getToken oder com.google.firebase.messaging.FirebaseMessagingService.onNewTokenabgerufen
    pushApp Zeichenfolge Name der Push-Anwendung, die dem Token zugeordnet ist, um die Registrierung aufzuheben. Diese Informationen werden in der Tabelle „Push-Anwendung“ in der zugehörigen Instanz ServiceNow gespeichert.
    erfolgreicher Rückruf Ausführbar Rückruf, der ausgeführt wird, wenn die Token-Aufhebung der Registrierung erfolgreich ist.
    Fehler rCallback Verbraucher <Auswerfbar> Rückruf, der ausgeführt wird, wenn die Aufhebung der Tokenregistrierung fehlschlägt.
    Tabelle : 7. Rückgaben
    Typ Beschreibung
    Keine

    Dieses Codebeispiel zeigt, wie die Registrierung eines Push-Tokens aufgehoben wird, z. B. wenn sich der Benutzer von der Anwendung abmeldet.

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