NMPushManager Class Reference
| Inherits from | NSObject |
| Declared in | NMPushManager.h NMPushManager.m |
Tasks
Other Methods
-
+ setDelegate:You can set any object that conforms to NMPushManagerDelegate protocol as the delegate for push notification events. By default, your application’s “AppDelegate” object is the delegate for events about push notifications sent from Netmera.
-
+ deviceTokenReturns the hexadecimal string representation of the ‘deviceToken’.
-
+ setUserNotificationCategories:Sets the set of UIUserNotificationCategory objects for interactive notifications.
-
+ setEnabledUserNotificationTypes:Sets enabled user notification types for push notifications.
Push Registration
-
+ registerWithCompletionHandler:Registers the device to Netmera for push notifications.
-
+ registerWithDeviceDetail:completionHandler:Registers the device with the related attributes – namely tag, customDictionary and location.
-
+ unregisterWithCompletionHandler:Unregisters the device completely from Netmera for push notifications.
-
+ unregisterWithDeviceDetail:completionHandler:Unregisters the device from the tags that just set on the given NMDeviceDetail object.
-
+ getDeviceTagsWithCompletionHandler:Returns all tags registered for device.
-
+ presentPushInboxFromController:Use this method to manually present push inbox on your view controller hierarchy. Push Inbox controller will be presented on given controller as a modalviewcontroller.
-
+ beginIgnoringRichPushesMethod which makes Netmera to ignore received rich pushes when application is on the foreground so that rich pushes does NOT interrupt users' actions.
-
+ endIgnoringRichPushesMethod which makes Netmera to stop ignoring received rich pushes when application is on the foreground so that rich pushes will be shown to user after this call.
-
+ loadingHUDReturns the indicator object used for the process of the loading of a rich push notification and push inbox.
-
+ setLoadingHUD:Sets the indicator object used for the process of the loading of a rich push notification and push inbox.
-
+ checkAvailabilityControls the availability of a rich push notification to show. Existance of internet connection is considered in the scope of availability.
Class Methods
beginIgnoringRichPushes
Method which makes Netmera to ignore received rich pushes when application is on the foreground so that rich pushes does NOT interrupt users' actions.
+ (void)beginIgnoringRichPushesDiscussion
Method which makes Netmera to ignore received rich pushes when application is on the foreground so that rich pushes does NOT interrupt users' actions.
Warning: If you call [NMPushManager beginIgnoringRichPushes] method in your code, received rich pushes during foreground state will be ignored by Netmera, and won’t be shown to user, until [NMPushManager endIgnoringRichPushes] method is called.
Declared In
NMPushManager.hcheckAvailability
Controls the availability of a rich push notification to show. Existance of internet connection is considered in the scope of availability.
+ (BOOL)checkAvailabilityReturn Value
availability of rich push notification.
Discussion
Controls the availability of a rich push notification to show. Existance of internet connection is considered in the scope of availability.
Declared In
NMPushManager.hdeviceToken
Returns the hexadecimal string representation of the ‘deviceToken’.
+ (NSString *)deviceTokenDiscussion
Returns the hexadecimal string representation of the ‘deviceToken’.
Declared In
NMPushManager.hendIgnoringRichPushes
Method which makes Netmera to stop ignoring received rich pushes when application is on the foreground so that rich pushes will be shown to user after this call.
+ (void)endIgnoringRichPushesDiscussion
Method which makes Netmera to stop ignoring received rich pushes when application is on the foreground so that rich pushes will be shown to user after this call.
Declared In
NMPushManager.hgetDeviceTagsWithCompletionHandler:
Returns all tags registered for device.
+ (void)getDeviceTagsWithCompletionHandler:(void ( ^ ) ( NSArray *tags , NSError *error ))handlerParameters
- handler
The block to execute when the fetch of the tags is completed.
Discussion
Returns all tags registered for device.
You should beware that tag list returned from this method contains the tags other devices registered to, not just the regarding device.
Declared In
NMPushManager.hloadingHUD
Returns the indicator object used for the process of the loading of a rich push notification and push inbox.
+ (NMProgressHUD *)loadingHUDReturn Value
NMProgressHUD object that is set for the loading indicator.
Discussion
Returns the indicator object used for the process of the loading of a rich push notification and push inbox.
Declared In
NMPushManager.hpresentPushInboxFromController:
Use this method to manually present push inbox on your view controller hierarchy. Push Inbox controller will be presented on given controller as a modalviewcontroller.
+ (void)presentPushInboxFromController:(UIViewController *)parentControllerParameters
- parentController
The controller object which will present push inbox modally.
Discussion
Use this method to manually present push inbox on your view controller hierarchy. Push Inbox controller will be presented on given controller as a modalviewcontroller.
Declared In
NMPushManager.hregisterWithCompletionHandler:
Registers the device to Netmera for push notifications.
+ (void)registerWithCompletionHandler:(void ( ^ ) ( BOOL deviceDidRegister , NSError *error ))handlerParameters
- handler
The block to execute when the registration of the device is completed.
Discussion
Registers the device to Netmera for push notifications.
Declared In
NMPushManager.hregisterWithDeviceDetail:completionHandler:
Registers the device with the related attributes – namely tag, customDictionary and location.
+ (void)registerWithDeviceDetail:(NMDeviceDetail *)deviceDetail completionHandler:(void ( ^ ) ( BOOL deviceDidRegister , NSError *error ))handlerParameters
- deviceDetail
The NMDeviceDetail object which contains the relevant attributes.
- handler
The block to execute when the registration of the device with the given attributes is completed.
Discussion
Registers the device with the related attributes – namely tag, customDictionary and location.
Declared In
NMPushManager.hsetDelegate:
You can set any object that conforms to NMPushManagerDelegate protocol as the delegate for push notification events. By default, your application’s “AppDelegate” object is the delegate for events about push notifications sent from Netmera.
+ (void)setDelegate:(id<NMPushManagerDelegate>)delegateDiscussion
You can set any object that conforms to NMPushManagerDelegate protocol as the delegate for push notification events. By default, your application’s “AppDelegate” object is the delegate for events about push notifications sent from Netmera.
Declared In
NMPushManager.hsetEnabledUserNotificationTypes:
Sets enabled user notification types for push notifications.
+ (void)setEnabledUserNotificationTypes:(UIUserNotificationType)typeParameters
- type
A UIUserNotificationType enum.
Discussion
Sets enabled user notification types for push notifications.
Declared In
NMPushManager.hsetLoadingHUD:
Sets the indicator object used for the process of the loading of a rich push notification and push inbox.
+ (void)setLoadingHUD:(NMProgressHUD *)progressHUDParameters
- progressHUD
Configured loading indicator.
Discussion
Sets the indicator object used for the process of the loading of a rich push notification and push inbox.
For a custom loading indicator, you should configure NMProgressHUD object. It offers a rich interface. By default, a basic design of NMProgressHUD is used.
Declared In
NMPushManager.hsetUserNotificationCategories:
Sets the set of UIUserNotificationCategory objects for interactive notifications.
+ (void)setUserNotificationCategories:(NSSet *)categoriesParameters
- categories
The set containing UIUserNotificationCategory objects.
Discussion
Sets the set of UIUserNotificationCategory objects for interactive notifications.
This method internally creates a UIUserNotificationSettings object having given categories, and registers the device to this settings object using registerUserNotificationSettings: method.
Warning: If any of the objects does NOT belong UIUserNotificationCategory class, method does NOT register the given category set.
Declared In
NMPushManager.hunregisterWithCompletionHandler:
Unregisters the device completely from Netmera for push notifications.
+ (void)unregisterWithCompletionHandler:(void ( ^ ) ( BOOL deviceDidUnregister , NSError *error ))handlerParameters
- handler
The block to execute when the unregistration of the device is completed.
Discussion
Unregisters the device completely from Netmera for push notifications.
Declared In
NMPushManager.hunregisterWithDeviceDetail:completionHandler:
Unregisters the device from the tags that just set on the given NMDeviceDetail object.
+ (void)unregisterWithDeviceDetail:(NMDeviceDetail *)deviceDetail completionHandler:(void ( ^ ) ( BOOL deviceDidUnregister , NSError *error ))handlerParameters
- deviceDetail
The NMDeviceDetail object which contains the tags that will be unregistered.
- handler
The block to execute when the unregistration of the device from the given tags is completed.
Discussion
Unregisters the device from the tags that just set on the given NMDeviceDetail object.
Declared In
NMPushManager.h