NowPushService クラス: Android

NowPushService クラスは、プッシュ通知サービスとの対話を可能にする関数を提供します。

表 : 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() をオーバーライドし、 RemoteMessage を NowPushService に渡す方法を示します。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: String, pushApp: String, successCallback: Runnable, errorCallback: Consumer<Throwable>)

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

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: String, pushApp: String, 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)
})