NMPushInboxList Class Reference
| Inherits from | NSObject |
| Declared in | NMPushInboxList.h NMPushInboxList.m |
Overview
NMPushInboxList is the class, which stores the rich push notifications that are shown in push inbox as a list. It also represents an interface for performing some operations upon this list.
Tasks
-
newPushReceivedThe boolean value regarding whether new rich push notification is received or not.
property -
delegateThe object that acts as the delegate of the receiving NMPushInboxList.
property -
+ sharedListReturns the list that includes the rich push notifications that are shown in push inbox.
-
– richPushObjectBeforeObject:Returns the NMRichPushObject, which is taken place before the current rich push object in the push inbox list.
-
– richPushObjectAfterObject:Returns the NMRichPushObject, which is taken place after the current rich push object in the push inbox list.
-
– recentPushObjectReturns the recently added NMPushObject.
-
– pushObjectAtIndex:Returns the NMPushObject, which is taken place in the given index of the push inbox list.
-
– indexOfPushObject:Returns the index of the NMPushObject in the push inbox list.
-
– removePushObjectAtIndex:Removes the NMPushObject at given index from the push inbox list.
-
– removePushObjectsAtIndexes:Removes the NMPushObject(s) at the indexes in given set from the push inbox list.
-
– markAsReadPushObjectsAtIndexes:Marks the rich push objects, which are taken place at the indexes of giving index set in the push inbox list as read.
-
– markAsReadPushObject:Marks the giving rich push object as read.
-
– markAsReadPushObjectAtIndex:Marks the rich push object, which is taken place at the giving index in the push inbox list as read.
-
– markAsUnreadPushObjectsAtIndexes:Marks the rich push objects, which are taken place at the indexes of giving index set in the push inbox list as unread.
-
– markAsUnreadPushObjectAtIndex:Marks the rich push object, which are taken place at the index in the push inbox list as unread.
-
– fetchPushInboxListFetches all read and unread rich pushes recorded for the device in the server. By default fetches notifications having inbox status NMPushInboxStatusRead or NMPushInboxStatusUnread AND having notification type NMNotificationTypeURLPush or NMNotificationTypeRich
-
– fetchPushInboxListWithNotificationTypes:inboxStatus:categoryArray:Fetches notifications with given filter parameters from Netmera.
-
+ fetchPushInboxCountWithNotificationTypes:inboxStatus:categoryArray:completionHandler:Returns number of notifications with given filter parameters in a block handler.
-
– addPushObject:Insert the given NMPushObject into the push inbox list.
-
– countReturns the number of the rich push objects, which are taken place in the push inbox list.
Properties
delegate
The object that acts as the delegate of the receiving NMPushInboxList.
@property (nonatomic, weak) id<NMPushInboxListDelegate> delegateDiscussion
The object that acts as the delegate of the receiving NMPushInboxList.
The delegate must adopt the NMPushInboxListDelegate protocol.
Declared In
NMPushInboxList.hClass Methods
fetchPushInboxCountWithNotificationTypes:inboxStatus:categoryArray:completionHandler:
Returns number of notifications with given filter parameters in a block handler.
+ (void)fetchPushInboxCountWithNotificationTypes:(NMNotificationType)types inboxStatus:(NMPushInboxStatus)statuses categoryArray:(NSArray *)categories completionHandler:(void ( ^ ) ( NSInteger count , NSError *error ))handlerParameters
- types
A bit mask specifying the types of the notifications to fetch from Netmera. For a list of values, see NMNotificationType.
- statuses
A bit mask specifying the push inbox status of the notifications to fetch from Netmera. For a list of values, see NMPushInboxStatus.
- categories
An array specifying categories of notifications. Return count is union of notifications (i.e. if you give @[@“A”,@“B”], method will return notifications having category value “A” OR “B”).
Discussion
Returns number of notifications with given filter parameters in a block handler.
Declared In
NMPushInboxList.hsharedList
Returns the list that includes the rich push notifications that are shown in push inbox.
+ (NMPushInboxList *)sharedListReturn Value
List of the rich push notifications
Discussion
Returns the list that includes the rich push notifications that are shown in push inbox.
Declared In
NMPushInboxList.hInstance Methods
addPushObject:
Insert the given NMPushObject into the push inbox list.
- (BOOL)addPushObject:(NMPushObject *)objectParameters
- object
NMPushObject object to add to the push inbox list.
Return Value
The boolean value regarding whether the given push object is added to the push inbox list.
Discussion
Insert the given NMPushObject into the push inbox list.
Declared In
NMPushInboxList.hcount
Returns the number of the rich push objects, which are taken place in the push inbox list.
- (NSInteger)countReturn Value
The total number of rich push notifications in the push inbox list.
Discussion
Returns the number of the rich push objects, which are taken place in the push inbox list.
Declared In
NMPushInboxList.hfetchPushInboxList
Fetches all read and unread rich pushes recorded for the device in the server. By default fetches notifications having inbox status NMPushInboxStatusRead or NMPushInboxStatusUnread AND having notification type NMNotificationTypeURLPush or NMNotificationTypeRich
- (void)fetchPushInboxListDiscussion
Fetches all read and unread rich pushes recorded for the device in the server. By default fetches notifications having inbox status NMPushInboxStatusRead or NMPushInboxStatusUnread AND having notification type NMNotificationTypeURLPush or NMNotificationTypeRich
Declared In
NMPushInboxList.hfetchPushInboxListWithNotificationTypes:inboxStatus:categoryArray:
Fetches notifications with given filter parameters from Netmera.
- (void)fetchPushInboxListWithNotificationTypes:(NMNotificationType)types inboxStatus:(NMPushInboxStatus)statuses categoryArray:(NSArray *)categoriesParameters
- types
A bit mask specifying the types of the notifications to fetch from Netmera. For a list of values, see NMNotificationType.
- statuses
A bit mask specifying the push inbox status of the notifications to fetch from Netmera. For a list of values, see NMPushInboxStatus.
- categories
An array specifying categories of notifications to fetch from Netmera. Response returns union of notifications (i.e. if you give @[@“A”,@“B”], method will return notifications having category value “A” OR “B”).
- handler
The block to execute when notification list is fetched from Netmera.
Discussion
Fetches notifications with given filter parameters from Netmera.
Declared In
NMPushInboxList.hindexOfPushObject:
Returns the index of the NMPushObject in the push inbox list.
- (NSInteger)indexOfPushObject:(NMPushObject *)objParameters
- obj
NMPushObject of which the index is wanted to get.
Return Value
Index value of the requested NMPushObject.
Discussion
Returns the index of the NMPushObject in the push inbox list.
Declared In
NMPushInboxList.hmarkAsReadPushObject:
Marks the giving rich push object as read.
- (BOOL)markAsReadPushObject:(NMPushObject *)objectParameters
- object
The rich push object to mark as read.
Return Value
The boolean value that indicates if rich push object is marked as read or not.
Discussion
Marks the giving rich push object as read.
Declared In
NMPushInboxList.hmarkAsReadPushObjectAtIndex:
Marks the rich push object, which is taken place at the giving index in the push inbox list as read.
- (BOOL)markAsReadPushObjectAtIndex:(NSInteger)indexParameters
- index
Index of the rich push object to mark as read
Return Value
The boolean value that indicates if rich push object at index is marked as read or not.
Discussion
Marks the rich push object, which is taken place at the giving index in the push inbox list as read.
Declared In
NMPushInboxList.hmarkAsReadPushObjectsAtIndexes:
Marks the rich push objects, which are taken place at the indexes of giving index set in the push inbox list as read.
- (BOOL)markAsReadPushObjectsAtIndexes:(NSIndexSet *)indexSetParameters
- indexSet
Indexes of the rich push objects to mark as read.
Return Value
The boolean value that indicates if rich push objects at indexes of index set are marked as read or not.
Discussion
Marks the rich push objects, which are taken place at the indexes of giving index set in the push inbox list as read.
Declared In
NMPushInboxList.hmarkAsUnreadPushObjectAtIndex:
Marks the rich push object, which are taken place at the index in the push inbox list as unread.
- (BOOL)markAsUnreadPushObjectAtIndex:(NSInteger)indexParameters
- index
Index of the rich push object to mark as unread.
Return Value
The boolean value that indicates if rich push object at index is marked as unread or not.
Discussion
Marks the rich push object, which are taken place at the index in the push inbox list as unread.
Declared In
NMPushInboxList.hmarkAsUnreadPushObjectsAtIndexes:
Marks the rich push objects, which are taken place at the indexes of giving index set in the push inbox list as unread.
- (BOOL)markAsUnreadPushObjectsAtIndexes:(NSIndexSet *)indexSetParameters
- indexSet
Indexes of the rich push objects to mark as unread.
Return Value
The boolean value that indicates if rich push objects at indexes of index set are marked as unread or not.
Discussion
Marks the rich push objects, which are taken place at the indexes of giving index set in the push inbox list as unread.
Declared In
NMPushInboxList.hpushObjectAtIndex:
Returns the NMPushObject, which is taken place in the given index of the push inbox list.
- (NMPushObject *)pushObjectAtIndex:(NSInteger)indexParameters
- index
Value of the NMPushObject that is wanted to get.
Return Value
NMPushObject at requested index.
Discussion
Returns the NMPushObject, which is taken place in the given index of the push inbox list.
Declared In
NMPushInboxList.hrecentPushObject
Returns the recently added NMPushObject.
- (NMPushObject *)recentPushObjectReturn Value
Latest NMPushObject in push inbox list.
Discussion
Returns the recently added NMPushObject.
Declared In
NMPushInboxList.hremovePushObjectAtIndex:
Removes the NMPushObject at given index from the push inbox list.
- (BOOL)removePushObjectAtIndex:(NSInteger)indexParameters
- index
Value of the NMPushObject, which is wanted to remove.
Return Value
The boolean value regarding whether the requested push object is removed or not.
Discussion
Removes the NMPushObject at given index from the push inbox list.
Declared In
NMPushInboxList.hremovePushObjectsAtIndexes:
Removes the NMPushObject(s) at the indexes in given set from the push inbox list.
- (BOOL)removePushObjectsAtIndexes:(NSIndexSet *)indexesParameters
- indexes
NSIndexSet object, which includes the indexes of NMPushObject(s), which are wanted to remove.
Return Value
The boolean value regarding whether the requested push objects are removed or not.
Discussion
Removes the NMPushObject(s) at the indexes in given set from the push inbox list.
Declared In
NMPushInboxList.hrichPushObjectAfterObject:
Returns the NMRichPushObject, which is taken place after the current rich push object in the push inbox list.
- (NMRichPushObject *)richPushObjectAfterObject:(NMPushObject *)objectParameters
- object
NMRichPushObject instance, which is before the requested rich push object.
Return Value
NMRichPushObject after the object given as parameter.
Discussion
Returns the NMRichPushObject, which is taken place after the current rich push object in the push inbox list.
Declared In
NMPushInboxList.hrichPushObjectBeforeObject:
Returns the NMRichPushObject, which is taken place before the current rich push object in the push inbox list.
- (NMRichPushObject *)richPushObjectBeforeObject:(NMPushObject *)objectParameters
- object
NMRichPushObject instance, which is after the requested rich push object.
Return Value
NMRichPushObject before the object given as parameter
Discussion
Returns the NMRichPushObject, which is taken place before the current rich push object in the push inbox list.
Declared In
NMPushInboxList.h