NowPushService クラス: Android

クラスには、プッシュ通知サービスとの対話を有効にする関数が用意されています。

表 : 1. プロパティ

名前	説明
構成	サービスに関連付けるサービス構成。 データタイプ: NowServiceConfiguration

NowPushService - handlePush(remoteMessage: RemoteMessage, successCallback: Consumer<NowPushPayload>, errorCallback: Consumer<Throwable>)

プッシュ通知要求を処理します。

注:

現在実装されているプッシュ通知タイプは NowPushVirtualAgent のみです。その他の渡されたプッシュ通知タイプは、 NotSupportedPushError オブジェクトを返します。

表 : 2. パラメーター

名前	タイプ	説明
リモートメッセージ	リモートメッセージ	com.google.firebase.messaging.FirebaseMessagingService.onMessageReceived によって受信された通知。詳細については、「 Android アプリでメッセージを受信する」を参照してください。
成功コールバック	コンシューマー <NowPushPayload>	処理 NowPushPayload 先を返すコールバック。
エラー コールバック	コンシューマー <スロー可能>	スローされたエラーを返すコールバック。エラー NotSupportedPushError がスローされた場合、通知タイプはモバイル SDK でサポートされていないため、モバイル SDK フレームワークの外部で処理する必要があります。

表 : 3. 返される内容

タイプ	説明
なし

この例は、onMessageReceived() を上書きして NowPushService に渡すRemoteMessage方法を示しています。NowPushService は、通知の種類を認識すると、要求を処理し、アプリケーションが処理する通知オブジェクトを返します。それ以外の場合は、 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: 文字列, pushApp: 文字列, successCallback: Runnable, errorCallback: Consumer<Throwable>)

現在のAndroidデバイスと指定されたアプリケーションのプッシュ通知を識別するために使用されるインスタンスに一意のFirebaseトークンServiceNowを登録します。

ServiceNowアプリケーションがアプリケーションから通知を受信する通知Androidデバイスをインスタンスで生成するには、このトークンを登録する必要があります。

表 : 4. パラメーター

名前	タイプ	説明
プッシュトークン	文字列	Firebasecom.google.firebase.messaging.FirebaseMessaging.getToken または com.google.firebase.messaging.FirebaseMessagingService.onNewToken によって取得されたトークン。
プッシュアプリ	文字列	関連する ServiceNow インスタンスのプッシュアプリケーションテーブルで指定されたプッシュアプリケーションの名前。
成功コールバック	実行可能ファイル	トークンの登録に成功したときに実行されるコールバック。
errorCallback	コンシューマー <スロー可能>	トークンの登録に失敗したときに実行されるコールバック。

表 : 5. 返される内容

タイプ	説明
なし

この例では、現在の Android デバイスとアプリケーション "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: 文字列, pushApp: 文字列, successCallback: Runnable, errorCallback: consumer<Throwable>)

指定された Firebase プッシュトークンの関連する ServiceNow インスタンスへの登録を解除します。

表 : 6. パラメーター

名前	タイプ	説明
プッシュトークン	文字列	Firebase 登録解除するトークン。com.google.firebase.messaging.FirebaseMessaging.getToken または com.google.firebase.messaging.FirebaseMessagingService.onNewToken によって取得されます。
プッシュアプリ	文字列	登録解除するトークンに関連付けられたプッシュアプリケーションの名前。この情報は、関連付けられた ServiceNow インスタンスのプッシュアプリケーションテーブルに保存されます。
成功コールバック	実行可能ファイル	トークンの登録解除に成功したときにコールバックが実行されました。
erro rCallback	コンシューマー <スロー可能>	トークンの登録解除に失敗したときに実行されるコールバック。

表 : 7. 返される内容

タイプ	説明
なし

このコード例は、ユーザーがアプリケーションからログアウトしたときなどにプッシュトークンの登録を解除する方法を示しています。

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