NBPushInstallation

@interface NBPushInstallation : NSObject

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

インスタレーション登録/更新/削除/取得を行うクラス

  • OS種別

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *osType;

    Swift

    var osType: String? { get }

  • OSバージョン

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *osVersion;

    Swift

    var osVersion: String? { get }

  • Device Token

    初期値はnil、nilオブジェクトは要求時のデータには含まれない。

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, nullable) NSString *deviceToken;

    Swift

    var deviceToken: String? { get set }

  • 使用する Push テクノロジを指定する

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *pushType;

    Swift

    var pushType: String? { get }

  • 購読するチャネルの一覧

    初期値はnil、nilオブジェクトは要求時のデータには含まれない。

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, nullable) NSArray *channels;

    Swift

    var channels: [Any]? { get set }

  • アプリケーションのバージョンコード

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSNumber *appVersionCode;

    Swift

    var appVersionCode: NSNumber? { get }

  • アプリケーションのバージョン

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *appVersionString;

    Swift

    var appVersionString: String? { get }

  • このインスタレーションに対して Push を送信可能なユーザ・グループを指定する。

    初期値は@[@g:anonymous]、nilオブジェクトは要求時のデータには含まれない。

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSArray *_Nonnull allowedSenders;

    Swift

    var allowedSenders: [Any] { get set }

  • 任意のKey-Value

    初期値はnil、nilオブジェクトは要求時のデータには含まれない。

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, nullable)
    NSDictionary<NSString *, id> *options;

    Swift

    var options: [String : Any]? { get set }

  • インスタレーションID

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *installationId;

    Swift

    var installationId: String? { get }

  • オーナー情報

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *owner;

    Swift

    var owner: String? { get }

  • インスタレーション登録

    インスタレーションの新規登録/完全上書き更新を行う。

    Declaration

    Objective-C

    - (void)saveInBackgroundWithBlock:(nonnull NBPushInstallationBlock)block;

    Swift

    func saveInBackground(completion block: @escaping NBPushInstallationBlock)

    Parameters

    block

    登録/更新結果を受け取るブロック

  • インスタレーション部分更新

    インスタレーションの部分更新を行う。

    Declaration

    Objective-C

    + (void)partUpdateInBackgroundWithDictionary:(nonnull NSDictionary *)dictionary
                                       block:(nonnull NBPushInstallationBlock)
                                                 block;

    Swift

    class func partUpdateInBackground(dictionary: [AnyHashable : Any], completion block: @escaping NBPushInstallationBlock)

    Parameters

    dictionary

    部分更新するデータのdictionary
    block

    更新結果を受け取るブロック

  • Device Token設定

    deviceTokenを16進数表記に変換し、@property deviceTokenに設定する。

    Declaration

    Objective-C

    - (void)setDeviceTokenFromData:(nonnull NSData *)deviceTokenData;

    Swift

    func setDeviceToken(fromData deviceTokenData: Data)

    Parameters

    deviceTokenData

    deviceToken(NSData型)

  • インスタレーション情報取得

    インスタレーション情報をキャッシュから取得する(通信を行わない)。

    Declaration

    Objective-C

    + (nonnull NBPushInstallation *)currentInstallation;

    Swift

    class func current() -> NBPushInstallation

    Return Value

    取得したインスタレーション情報

  • インスタレーション情報取得

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

    Declaration

    Objective-C

    + (void)refreshCurrentInstallationInBackgroundWithBlock:
    (nonnull NBPushInstallationBlock)block;

    Swift

    class func refreshCurrentInstallationInBackground(completion block: @escaping NBPushInstallationBlock)

    Parameters

    block

    取得結果を受け取るブロック

  • インスタレーション削除

    インスタレーションの削除を行う。

    Declaration

    Objective-C

    - (void)deleteInBackgroundWithBlock:(nonnull NBResultBlock)block;

    Swift

    func deleteInBackground(completion block: @escaping NBResultBlock)

    Parameters

    block

    実行結果を受け取るブロック