-
CORE PUSHの設定キー
Declaration
Objective-C
@property (readwrite, strong, nonatomic, nullable) NSString *configKey;
Swift
var configKey: String? { get set }
-
カテゴリIDの配列
Declaration
Objective-C
@property (readwrite, strong, nonatomic, nullable) NSArray<NSString *> *categoryIds;
Swift
var categoryIds: [String]? { get set }
-
2次元カテゴリの辞書オブジェクト
Declaration
Objective-C
@property (readwrite, strong, nonatomic, nullable) NSDictionary<NSString *, NSArray<NSString *> *> *multiCategoryIds;
Swift
var multiCategoryIds: [String : [String]]? { get set }
-
アプリのユーザーID
Declaration
Objective-C
@property (readwrite, strong, nonatomic, nullable) NSString *appUserId;
Swift
var appUserId: String? { get set }
-
デバイストークン
Declaration
Objective-C
@property (readonly, nonatomic, nullable) NSString *deviceToken;
Swift
var deviceToken: String? { get }
-
デバイストークンがCORE ASPサーバに送信済みかを判定するフラグ
Declaration
Objective-C
@property (readonly, nonatomic) BOOL isDeviceTokenSentToServer;
Swift
var isDeviceTokenSentToServer: Bool { get }
-
CorePushManagerクラスのシングルトンオブジェクト
Declaration
Objective-C
@property (readonly, nonatomic, nonnull, class) CorePushManager *shared;
Swift
class var shared: CorePushManager { get }
-
CorePushManagerDelegateプロトコルを実装したクラス
Declaration
Objective-C
@property (assign, readwrite, nonatomic, nullable) id<CorePushManagerDelegate> delegate;
Swift
unowned(unsafe) var delegate: CorePushManagerDelegate? { get set }
-
アプリケーションアイコンのバッジ数をリセットします。
Declaration
Objective-C
+ (void)resetApplicationIconBadgeNumber;
Swift
class func resetApplicationIconBadgeNumber()
-
アプリケーションアイコンのバッジ数を設定します。
Declaration
Objective-C
+ (void)setApplicationIconBadgeNumber:(NSInteger)number;
Swift
class func setApplicationIconBadgeNumber(_ number: Int)
Parameters
number
バッジ数
-
APNSの通知サービスにデバイスを登録します。
デフォルトでは通知のアラート、バッジ、サウンドをONに設定します。Declaration
Objective-C
- (void)registerForRemoteNotifications;
Swift
func registerForRemoteNotifications()
-
APNSの通知サービスにデバイスを登録します。
Declaration
Objective-C
- (void)registerForRemoteNotificationTypes: (CorePushRemoteNotificationType)types;
Swift
func register(forRemoteNotificationTypes types: CorePushRemoteNotificationType)
Parameters
types
通知タイプ
-
CORE ASPサーバにデバイストークンを登録します。
変換したデバイストークンの文字列は UserDefaultsに CorePushDeviceTokenKeyキーで保存されます。
デバイストークンの登録が成功した場合は CorePushManagerRegisterTokenRequestSuccessNotification の通知キーで NSNotificationCenter に通知を行います。
デバイストークンの登録が失敗した場合は CorePushManagerRegisterTokenRequestFailNotification の通知キーで NSNotificationCenterに通知を行います。Declaration
Objective-C
- (void)registerDeviceToken:(nonnull NSData *)token;
Swift
func registerDeviceToken(_ token: Data)
Parameters
token
APNSサーバから取得したデバイストークンのバイト列。
-
CORE ASPサーバにデバイストークンを登録します。
変換したデバイストークンの文字列は UserDefaultsに CorePushDeviceTokenKeyキー で保存されます。
デバイストークンの登録が成功した場合は CorePushManagerRegisterTokenRequestSuccessNotification の通知キーで NSNotificationCenter に通知を行います。
デバイストークンの登録が失敗した場合は CorePushManagerRegisterTokenRequestFailNotification の通知キーで NSNotificationCenterに通知を行います。Declaration
Objective-C
- (void)registerDeviceTokenString:(nonnull NSString *)token;
Swift
func registerDeviceTokenString(_ token: String)
Parameters
token
APNSサーバから取得したデバイストークンの文字列。
-
CORE PUSHからデバイストークンを削除します。
デバイストークン削除時に UserDefaultsのCorePushDeviceTokenKeyキーに保存されたデバイストークンを空文字で保存します。
デバイストークンの削除が成功した場合は CorePushManagerUnregisterTokenRequestSuccessNotification の通知キーで NSNotificationCenter に通知を行います。
デバイストークンの削除が失敗した場合は CorePushManagerUnregisterTokenRequestFailNotification の通知キーで NSNotificationCenter に通知を行います。Declaration
Objective-C
- (void)unregisterDeviceToken;
Swift
func unregisterDeviceToken()
-
指定のURLにユーザー属性を送信します。
Declaration
Objective-C
- (void)registerUserAttributes:(nonnull NSArray<NSString *> *)attributes api:(nonnull NSString *)url;
Swift
func registerUserAttributes(_ attributes: [String], api url: String)
Parameters
attributes
ユーザー属性の配列
url
ユーザー属性を送信するurl
-
アプリがフォアグランド・バックグランド状態で動作中に通知を受信した時の動作を定義します。
バックラウンド状態で通知を受信後に通知からアプリを起動した場合、CorePushManagerDelegate#handleBackgroundNotificationが呼び出されます。
フォアグランド状態で通知を受信した場合、CorePushManagerDelegate#handleForegroundNotificationが呼び出されます。Declaration
Objective-C
- (void)handleRemoteNotification:(nonnull NSDictionary *)userInfo;
Swift
func handleRemoteNotification(_ userInfo: [AnyHashable : Any])
Parameters
userInfo
通知の情報を含むオブジェクト
-
アプリのプロセスが起動していない状態で通知からアプリを起動した時の処理を定義します。
launchOptionsに通知のUserInfoが存在する場合は、CorePushManagerDelegate#handleLaunchingNotificationを呼び出し、存在しない場合は何も行いません。Declaration
Objective-C
- (void)handleLaunchingNotificationWithOption: (nullable NSDictionary *)launchOptions;
Swift
func handleLaunchingNotification(withOption launchOptions: [AnyHashable : Any]?)
Parameters
launchOptions
起動オプション。UIApplicationLaunchOptionsRemoteNotificationKeyをキーにUserInfoオブジェクトを取得します。