CorePushManager Class Reference
| Inherits from | NSObject |
| Conforms to | CLLocationManagerDelegate CorePushManagerDelegate CorePushRegisterTokenRequestDelegate CorePushRegisterUserAttributesRequestDelegate CorePushUnregisterTokenRequestDelegate |
| Declared in | CorePushManager.h CorePushManager.m |
Tasks
Other Methods
-
+ sharedシングルトンインスタンスの生成
-
– setConfigKey:CORE PUSHのコンフィグキーを設定する
-
– setPushEnabled:CORE PUSHの通知設定の有無を設定する
-
– setDebugEnabled:CORE PUSHのデバッグログを出力する
-
– setDeviceIdEnabled:デバイスIDをCORE PUSHサーバに送信するかを設定する。
-
– setDeviceIdHashEnabled:デバイスIDをMD5ハッシュ化の有無を設定する。
-
– setCategoryIds:CORE PUSHのカテゴリIDを設定する。
-
– setMultiCategoryIds:CORE PUSHのカテゴリIDを設定する。
-
– setAppUserId:CORE PUSHのユーザーIDを設定する。 @param アプリのユーザーID。
-
– registerForRemoteNotificationsAPNSの通知サービスにデバイスを登録する。 デフォルトでは通知のアラート、バッジ、サウンドをONに設定
-
– registerForRemoteNotificationTypes:APNSの通知サービスにデバイスを登録する。
-
– registerDeviceToken:CORE PUSHにデバイストークンを登録する。
変換したデバイストークンの文字列は UserDefaultsに CorePushDeviceTokenKeyキー で保存されます。
デバイストークンの登録が成功した場合は CorePushManagerRegisterTokenRequestSuccessNotification の通知キーで NSNotificationCenter に 通知を行います。
デバイストークンの登録が失敗した場合は CorePushManagerRegisterTokenRequestFailNotification の通知キーで NSNotificationCenterに通知を行います。 -
– registerDeviceTokenString:CORE PUSHにデバイストークンを登録する。
変換したデバイストークンの文字列は UserDefaultsに CorePushDeviceTokenKeyキー で保存されます。
デバイストークンの登録が成功した場合は CorePushManagerRegisterTokenRequestSuccessNotification の通知キーで NSNotificationCenter に 通知を行います。
デバイストークンの登録が失敗した場合は CorePushManagerRegisterTokenRequestFailNotification の通知キーで NSNotificationCenterに通知を行います。 -
– unregisterDeviceTokenCORE PUSHからデバイストークンを削除する
デバイストークン削除時に UserDefaults の CPDeviceTokenキー に保存されたデバイストークンを空文字で保存します。
デバイストークンの削除が成功した場合は CorePushManagerUnregisterTokenRequestSuccessNotification の通知キーで NSNotificationCenter に通知を行います。
デバイストークンの削除が失敗した場合は CorePushManagerUnregisterTokenRequestFailNotification の通知キーで NSNotificationCenter に通知を行います。 -
– registerUserAttributes:api:指定のURLにユーザー属性を送信する。
-
– handleRemoteNotification:アプリがフォアグランド・バックグランド状態で動作中に通知を受信した時の動作を定義する。
バックラウンド状態で通知を受信後に通知からアプリを起動した場合、 CorePushManagerDelegate#handleBackgroundNotificationが呼び出されます。
フォアグランド状態で通知を受信した場合、CorePushManagerDelegate#handleForegroundNotificationが呼び出されます。 -
– handleLaunchingNotificationWithOption:アプリのプロセスが起動していない状態で通知からアプリを起動した時の処理を定義する。
launchOptionsに通知のUserInfoが存在する場合は、CorePushManagerDelegate#handleLaunchingNotificationを 呼び出し、存在しない場合は何も行わない。 -
– handleBackgroundNotification:アプリがバックグランドで動作中に通知からアプリを起動した時に CorePushManager#handleRemoteNotification から呼び出されます。
-
– handleForegroundNotifcation:アプリがフォアグランドで動作中に通知を受信した時に CorePushManager#handleRemoteNotification から呼び出されます。
-
– handleLaunchingNotification:アプリのプロセスが起動していない状態で通知からアプリを起動した時に CorePushManager#handleLaunchingNotificationWithOption から呼び出されます。
-
+ resetApplicationIconBadgeNumberアプリケーションアイコンのバッジ数をリセットする
-
+ setApplicationIconBadgeNumber:アプリケーションアイコンのバッジ数を設定する。
-
– registerTokenRequestSuccessCORE PUSHからデバイストークンの登録が成功した時に呼ばれる
-
– registerTokenRequestFailCORE PUSHからデバイストークンの登録が失敗した時に呼ばれる
-
– unregisterTokenRequestSuccessCORE PUSHからデバイストークンの削除が成功した時に呼ばれる
-
– unregisterTokenRequestFailCORE PUSHからデバイストークンの削除が失敗した時に呼ばれる
-
– registerUserAttributesRequestSuccessCORE PUSHからデバイストークンの登録が成功した時に呼ばれる
-
– registerUserAttributesRequestFailCORE PUSHからデバイストークンの登録が失敗した時に呼ばれる
-
– reportCurrentLocation現在の位置情報を送信する
Other Methods
-
configKeyCORE PUSHのコンフィグキーを設定する
property -
pushEnabledCORE PUSHの通知設定の有無を設定する
property -
debugEnabledCORE PUSHのデバッグログを出力する
property -
deviceIdEnabledデバイスIDをCORE PUSHサーバに送信するかを設定する。
property -
deviceIdHashEnabledデバイスIDをMD5ハッシュ化の有無を設定する。
property -
categoryIdsCORE PUSHのカテゴリIDを設定する。
property -
multiCategoryIdsCORE PUSHのカテゴリIDを設定する。
property -
appUserIdCORE PUSHのユーザーIDを設定する。 @param アプリのユーザーID。
property -
delegateCorePushManagerDelegateプロトコルを実装したクラス
property
Properties
appUserId
CORE PUSHのユーザーIDを設定する。 @param アプリのユーザーID。
@property (nonatomic, retain) NSString *appUserIdDeclared In
CorePushManager.hcategoryIds
CORE PUSHのカテゴリIDを設定する。
@property (nonatomic, retain) NSMutableArray *categoryIdsParameters
- categoryIds
カテゴリIDの配列
Declared In
CorePushManager.hconfigKey
CORE PUSHのコンフィグキーを設定する
@property (nonatomic, retain) NSString *configKeyParameters
- configKey
CORE PUSHのコンフィグキーの値。
指定したコンフィグキーは UserDefaultsに CorePushConfigKey のキーで保存されます。
Declared In
CorePushManager.hdebugEnabled
CORE PUSHのデバッグログを出力する
@property (nonatomic, assign) BOOL debugEnabledParameters
- debugEnable
デバッグログを出力する場合は YES、出力しない場合は NOを設定する
Declared In
CorePushManager.hdelegate
CorePushManagerDelegateプロトコルを実装したクラス
@property (nonatomic, assign) id<CorePushManagerDelegate> delegateDeclared In
CorePushManager.hdeviceIdEnabled
デバイスIDをCORE PUSHサーバに送信するかを設定する。
@property (nonatomic, assign) BOOL deviceIdEnabledParameters
- deviceIdEnabled。デバイスIDを送信する場合は
YES、送信しない場合は NOを設定する。デフォルト値は NO。
Declared In
CorePushManager.hdeviceIdHashEnabled
デバイスIDをMD5ハッシュ化の有無を設定する。
@property (nonatomic, assign) BOOL deviceIdHashEnabledParameters
- deviceIdHashEnabled
ハッシュ化する場合は YES、ハッシュ化しない場合はNOを設定する。デフォルト値は NO。
Declared In
CorePushManager.hClass Methods
resetApplicationIconBadgeNumber
アプリケーションアイコンのバッジ数をリセットする
+ (void)resetApplicationIconBadgeNumberDeclared In
CorePushManager.hInstance Methods
handleBackgroundNotification:
アプリがバックグランドで動作中に通知からアプリを起動した時に CorePushManager#handleRemoteNotification から呼び出されます。
- (void)handleBackgroundNotification:(NSDictionary *)userInfoParameters
- userInfo
通知情報を含むオブジェクト
Declared In
CorePushManager.hhandleForegroundNotifcation:
アプリがフォアグランドで動作中に通知を受信した時に CorePushManager#handleRemoteNotification から呼び出されます。
- (void)handleForegroundNotifcation:(NSDictionary *)userInfoParameters
- userInfo
通知情報を含むオブジェクト
Declared In
CorePushManager.hhandleLaunchingNotification:
アプリのプロセスが起動していない状態で通知からアプリを起動した時に CorePushManager#handleLaunchingNotificationWithOption から呼び出されます。
- (void)handleLaunchingNotification:(NSDictionary *)userInfoParameters
- userInfo
通知情報を含むオブジェクト
Declared In
CorePushManager.hhandleLaunchingNotificationWithOption:
アプリのプロセスが起動していない状態で通知からアプリを起動した時の処理を定義する。
launchOptionsに通知のUserInfoが存在する場合は、CorePushManagerDelegate#handleLaunchingNotificationを
呼び出し、存在しない場合は何も行わない。
- (void)handleLaunchingNotificationWithOption:(NSDictionary *)launchOptionsParameters
- launchOptions
起動オプション。UIApplicationLaunchOptionsRemoteNotificationKeyをキーにUserInfoオブジェクトを取得する
Declared In
CorePushManager.hhandleRemoteNotification:
アプリがフォアグランド・バックグランド状態で動作中に通知を受信した時の動作を定義する。
バックラウンド状態で通知を受信後に通知からアプリを起動した場合、
CorePushManagerDelegate#handleBackgroundNotificationが呼び出されます。
フォアグランド状態で通知を受信した場合、CorePushManagerDelegate#handleForegroundNotificationが呼び出されます。
- (void)handleRemoteNotification:(NSDictionary *)userInfoParameters
- userInfo
通知の情報を含むオブジェクト
Declared In
CorePushManager.hregisterDeviceToken:
CORE PUSHにデバイストークンを登録する。
変換したデバイストークンの文字列は UserDefaultsに CorePushDeviceTokenKeyキー で保存されます。
デバイストークンの登録が成功した場合は CorePushManagerRegisterTokenRequestSuccessNotification の通知キーで NSNotificationCenter に
通知を行います。
デバイストークンの登録が失敗した場合は CorePushManagerRegisterTokenRequestFailNotification の通知キーで NSNotificationCenterに通知を行います。
- (void)registerDeviceToken:(NSData *)tokenParameters
- token
APNSサーバから取得したデバイストークンのバイト列。
Declared In
CorePushManager.hregisterDeviceTokenString:
CORE PUSHにデバイストークンを登録する。
変換したデバイストークンの文字列は UserDefaultsに CorePushDeviceTokenKeyキー で保存されます。
デバイストークンの登録が成功した場合は CorePushManagerRegisterTokenRequestSuccessNotification の通知キーで NSNotificationCenter に
通知を行います。
デバイストークンの登録が失敗した場合は CorePushManagerRegisterTokenRequestFailNotification の通知キーで NSNotificationCenterに通知を行います。
- (void)registerDeviceTokenString:(NSString *)tokenParameters
- token
APNSサーバから取得したデバイストークンの文字列。
Declared In
CorePushManager.hregisterForRemoteNotificationTypes:
APNSの通知サービスにデバイスを登録する。
- (void)registerForRemoteNotificationTypes:(UIRemoteNotificationType)typesParameters
- types
通知タイプ
Declared In
CorePushManager.hregisterForRemoteNotifications
APNSの通知サービスにデバイスを登録する。 デフォルトでは通知のアラート、バッジ、サウンドをONに設定
- (void)registerForRemoteNotificationsDeclared In
CorePushManager.hregisterTokenRequestFail
CORE PUSHからデバイストークンの登録が失敗した時に呼ばれる
- (void)registerTokenRequestFailDeclared In
CorePushRegisterTokenRequest.hregisterTokenRequestSuccess
CORE PUSHからデバイストークンの登録が成功した時に呼ばれる
- (void)registerTokenRequestSuccessDeclared In
CorePushRegisterTokenRequest.hregisterUserAttributes:api:
指定のURLにユーザー属性を送信する。
- (void)registerUserAttributes:(NSArray *)attributes api:(NSString *)urlParameters
- attributes
ユーザー属性の配列
- url
ユーザー属性を送信するurl
Declared In
CorePushManager.hregisterUserAttributesRequestFail
CORE PUSHからデバイストークンの登録が失敗した時に呼ばれる
- (void)registerUserAttributesRequestFailDeclared In
CorePushManager.mregisterUserAttributesRequestSuccess
CORE PUSHからデバイストークンの登録が成功した時に呼ばれる
- (void)registerUserAttributesRequestSuccessDeclared In
CorePushManager.msetAppUserId:
CORE PUSHのユーザーIDを設定する。 @param アプリのユーザーID。
- (void)setAppUserId:(NSString *)appUserIdDeclared In
CorePushManager.hsetCategoryIds:
CORE PUSHのカテゴリIDを設定する。
- (void)setCategoryIds:(NSMutableArray *)categoryIdsParameters
- categoryIds
カテゴリIDの配列
Declared In
CorePushManager.hsetConfigKey:
CORE PUSHのコンフィグキーを設定する
- (void)setConfigKey:(NSString *)configKeyParameters
- configKey
CORE PUSHのコンフィグキーの値。
指定したコンフィグキーは UserDefaultsに CorePushConfigKey のキーで保存されます。
Declared In
CorePushManager.hsetDebugEnabled:
CORE PUSHのデバッグログを出力する
- (void)setDebugEnabled:(BOOL)debugEnabledParameters
- debugEnable
デバッグログを出力する場合は YES、出力しない場合は NOを設定する
Declared In
CorePushManager.hsetDeviceIdEnabled:
デバイスIDをCORE PUSHサーバに送信するかを設定する。
- (void)setDeviceIdEnabled:(BOOL)deviceIdEnabledParameters
- deviceIdEnabled。デバイスIDを送信する場合は
YES、送信しない場合は NOを設定する。デフォルト値は NO。
Declared In
CorePushManager.hsetDeviceIdHashEnabled:
デバイスIDをMD5ハッシュ化の有無を設定する。
- (void)setDeviceIdHashEnabled:(BOOL)deviceIdHashEnabledParameters
- deviceIdHashEnabled
ハッシュ化する場合は YES、ハッシュ化しない場合はNOを設定する。デフォルト値は NO。
Declared In
CorePushManager.hsetMultiCategoryIds:
CORE PUSHのカテゴリIDを設定する。
- (void)setMultiCategoryIds:(NSMutableDictionary *)multiCategoryIdsParameters
- categoryIds
カテゴリIDのディクショナリ。カテゴリIDをキーにサブカテゴリID の配列を指定。
Declared In
CorePushManager.hsetPushEnabled:
CORE PUSHの通知設定の有無を設定する
- (void)setPushEnabled:(BOOL)pushEnabledParameters
- pushEnabled
CORE PUSHの通知設定が有効な場合は YES、無効な場合は NO を設定する。
指定した値は UserDefaultsに CorePushPushEnabledKey のキーで保存されます。
Declared In
CorePushManager.hunregisterDeviceToken
CORE PUSHからデバイストークンを削除する
デバイストークン削除時に UserDefaults の CPDeviceTokenキー に保存されたデバイストークンを空文字で保存します。
デバイストークンの削除が成功した場合は CorePushManagerUnregisterTokenRequestSuccessNotification の通知キーで NSNotificationCenter に通知を行います。
デバイストークンの削除が失敗した場合は CorePushManagerUnregisterTokenRequestFailNotification の通知キーで NSNotificationCenter に通知を行います。
- (void)unregisterDeviceTokenDeclared In
CorePushManager.h