MCEInboxDatabase Class Reference

Inherits from NSObject
Declared in MCEInboxDatabase.h
MCEInboxDatabase.m

Overview

The MCEInboxDatabase class owns and interacts with the inbox database.

+ sharedInstance

This method returns the singleton object of this class.

+ (instancetype)sharedInstance

Discussion

This method returns the singleton object of this class.

Declared In

MCEInboxDatabase.h

– unreadMessageCount

Returns the number of unread messages in the inbox

- (int)unreadMessageCount

Discussion

Returns the number of unread messages in the inbox

Declared In

MCEInboxDatabase.h

– messageCount

Returns the number of messages in the inbox

- (int)messageCount

Discussion

Returns the number of messages in the inbox

Declared In

MCEInboxDatabase.h

– inboxMessagesAscending:

The inboxMessagesAscending: method retrieves an NSArray of MCEInboxMessage objects from the inbox database.

- (NSMutableArray *)inboxMessagesAscending:(BOOL)ascending

Parameters

ascending

A boolean value that toggles if the contents should be sorted ascending (TRUE) or descending (FALSE)

Return Value

Returns an NSArray of MCEInboxMessage objects or a nil value in the case of failure.

Discussion

The inboxMessagesAscending: method retrieves an NSArray of MCEInboxMessage objects from the inbox database.

Declared In

MCEInboxDatabase.h

– inboxMessageWithRichContentId:

The inboxMessageWithRichContentId: method returns the latest inbox message for the specified richContentId.

- (MCEInboxMessage *)inboxMessageWithRichContentId:(NSString *)richContentId

Parameters

richContentId

A unique identifier for the rich content.

Return Value

Returns the most recent MCEInboxMessage object or a nil value in the case of failure.

Discussion

The inboxMessageWithRichContentId: method returns the latest inbox message for the specified richContentId.

Declared In

MCEInboxDatabase.h

– inboxMessageWithInboxMessageId:

The inboxMessageWithInboxMessageId: method retrieves a single MCEInboxMessage object from the inbox database by inboxMessageId.

- (MCEInboxMessage *)inboxMessageWithInboxMessageId:(NSString *)inboxMessageId

Parameters

inboxMessageId

A unique identifier for the inbox message.

Return Value

Returns a single MCEInboxMessage object or a nil value in the case of failure.

Discussion

The inboxMessageWithInboxMessageId: method retrieves a single MCEInboxMessage object from the inbox database by inboxMessageId.

Declared In

MCEInboxDatabase.h

– clearExpiredMessages

Clears expired messages from the database.

- (void)clearExpiredMessages

Discussion

Clears expired messages from the database.

Declared In

MCEInboxDatabase.h