com.nec.baas.push

クラス NbFcmPushInstallation

java.lang.Object

NbAndroidPushInstallation

com.nec.baas.push.NbFcmPushInstallation

直系の既知のサブクラス:

NbGCMPushInstallation

public class NbFcmPushInstallation
extends NbAndroidPushInstallation

FCM Pushインスタレーションクラス。

FCM Pushのインスタレーション登録/更新/削除/取得を行う。

最初に getCurrentInstallation() を呼び出した時点で、最後に作成されていた NbService のインスタンスが利用される。

導入されたバージョン:

6.0.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static NbFcmPushInstallation	getCurrentInstallation() 現在の FCM Pushインスタレーション情報を取得する。
boolean	isRegistered() FCM/GCMへの登録状態の確認を行う。
static void	partUpdateInstallation(NbJSONObject data, NbFcmPushInstallationCallback callback) 非推奨です。
static void	refreshCurrentInstallation(NbFcmPushInstallationCallback callback) インスタレーション情報をAPIサーバから取得する。
void	save(NbFcmPushInstallationCallback callback) APIサーバに対してインスタレーションの新規登録/完全上書き更新を行う。
void	saveRegistrationToken(java.lang.String registrationToken) Registration Token を保存する (FCM / GCM3.0以降用)。

クラスから継承されたメソッド java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

メソッドの詳細

getCurrentInstallation

public static NbFcmPushInstallation getCurrentInstallation()

現在の FCM Pushインスタレーション情報を取得する。

戻り値:

インスタレーション情報

例外:

java.lang.IllegalStateException

saveRegistrationToken

public void saveRegistrationToken(java.lang.String registrationToken)

Registration Token を保存する (FCM / GCM3.0以降用)。

InstanceIDListenerService で registration ID / token を受取り 本 API で保存すること。

パラメータ:

registrationToken - Registration Token

save

public void save(NbFcmPushInstallationCallback callback)

APIサーバに対してインスタレーションの新規登録/完全上書き更新を行う。

事前にFCM/GCMへの登録が完了している必要がある。
事前に購読するチャネルの一覧とインスタレーションに対して Push を送信可能なユーザ・グループを設定する必要がある。

パラメータ:

callback - 登録したインスタレーション情報を受け取るコールバック

関連項目:

NbAndroidPushInstallation#setChannels(java.util.Set), NbAndroidPushInstallation#setAllowedSenders(java.util.Set), NbFcmPushInstallationCallback

partUpdateInstallation

@Deprecated
public static void partUpdateInstallation(NbJSONObject data,
                                                      NbFcmPushInstallationCallback callback)

非推奨です。

APIサーバに対してインスタレーションの部分更新を行う。

パラメータ:

data - 部分更新するデータ

callback - 登録したインスタレーション情報を受け取るコールバック

関連項目:

NbFcmPushInstallationCallback

refreshCurrentInstallation

public static void refreshCurrentInstallation(NbFcmPushInstallationCallback callback)

インスタレーション情報をAPIサーバから取得する。

パラメータ:

callback - 取得したインスタレーション情報を受け取るコールバック

関連項目:

NbFcmPushInstallationCallback

isRegistered

public boolean isRegistered()

FCM/GCMへの登録状態の確認を行う。

戻り値:

FCM/GCMに登録済の場合はtrue、未登録の場合はfalseを返す