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

Properties

delegate

The object that acts as the delegate of the receiving NMPushInboxList.

@property (nonatomic, assign) id<NMPushInboxListDelegate> delegate

Discussion

The object that acts as the delegate of the receiving NMPushInboxList.

The delegate must adopt the NMPushInboxListDelegate protocol.

Declared In

NMPushInboxList.h

newPushReceived

The boolean value regarding whether new rich push notification is received or not.

@property (nonatomic, assign) BOOL newPushReceived

Discussion

The boolean value regarding whether new rich push notification is received or not.

Declared In

NMPushInboxList.h

Class Methods

sharedList

Returns the list that includes the rich push notifications that are shown in push inbox.

+ (NMPushInboxList *)sharedList

Return 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.h

Instance Methods

addPushObject:

Insert the given NMPushObject into the push inbox list.

- (BOOL)addPushObject:(NMPushObject *)object

Parameters

NMPushObject,

which is wanted 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.h

count

Returns the number of the rich push objects, which are taken place in the push inbox list.

- (NSInteger)count

Return 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.h

fetchPushInboxList

Fetches all read and unread rich pushes recorded for the device in the server.

- (void)fetchPushInboxList

Discussion

Fetches all read and unread rich pushes recorded for the device in the server.

Declared In

NMPushInboxList.h

indexOfPushObject:

Returns the index of the NMPushObject in the push inbox list.

- (NSInteger)indexOfPushObject:(NMPushObject *)obj

Parameters

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.h

markAsReadPushObject:

Marks the giving rich push object as read.

- (BOOL)markAsReadPushObject:(NMPushObject *)object

Parameters

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.h

markAsReadPushObjectAtIndex:

Marks the rich push object, which is taken place at the giving index in the push inbox list as read.

- (BOOL)markAsReadPushObjectAtIndex:(NSInteger)index

Parameters

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.h

markAsReadPushObjectsAtIndexes:

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 *)indexSet

Parameters

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.h

markAsUnreadPushObjectAtIndex:

Marks the rich push object, which are taken place at the index in the push inbox list as unread.

- (BOOL)markAsUnreadPushObjectAtIndex:(NSInteger)index

Parameters

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.h

markAsUnreadPushObjectsAtIndexes:

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 *)indexSet

Parameters

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.h

pushObjectAtIndex:

Returns the NMPushObject, which is taken place in the given index of the push inbox list.

- (NMPushObject *)pushObjectAtIndex:(NSInteger)index

Parameters

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.h

recentPushObject

Returns the recently added NMPushObject.

- (NMPushObject *)recentPushObject

Return Value

Latest NMPushObject in push inbox list.

Discussion

Returns the recently added NMPushObject.

Declared In

NMPushInboxList.h

removePushObjectAtIndex:

Removes the NMPushObject at given index from the push inbox list.

- (BOOL)removePushObjectAtIndex:(NSInteger)index

Parameters

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.h

removePushObjectsAtIndexes:

Removes the NMPushObject(s) at the indexes in given set from the push inbox list.

- (BOOL)removePushObjectsAtIndexes:(NSIndexSet *)indexes

Parameters

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.h

richPushObjectAfterObject:

Returns the NMRichPushObject, which is taken place after the current rich push object in the push inbox list.

- (NMRichPushObject *)richPushObjectAfterObject:(NMPushObject *)object

Parameters

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.h

richPushObjectBeforeObject:

Returns the NMRichPushObject, which is taken place before the current rich push object in the push inbox list.

- (NMRichPushObject *)richPushObjectBeforeObject:(NMPushObject *)object

Parameters

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