MCEInAppMessage Class Reference

Inherits from NSObject
Declared in MCEInAppMessage.h
MCEInAppMessage.m

Overview

The MCEInAppMessage class represents a single in app message.

Other Methods

– mailingId

The mailingId property represents the mailingId from the original push message.

- (id)mailingId

Discussion

The mailingId property represents the mailingId from the original push message.

Declared In

MCEInAppMessage.h

+ inAppMessageFromResultSet:

The inAppMessageFromResultSet: method allocates and constructs a MCEInAppMessage object from a database result set.

+ (instancetype)inAppMessageFromResultSet:(MCEResultSet *)resultSet

Parameters

resultSet

The resultSet parameter is a database result set object from the inAppMessage table.

Return Value

Returns a fully allocated and initialized MCEInAppMessage object.

Discussion

The inAppMessageFromResultSet: method allocates and constructs a MCEInAppMessage object from a database result set.

Declared In

MCEInAppMessage.h

– initFromResultSet:

The initFromResultSet: method constructs a MCEInAppMessage object from a database result set.

- (instancetype)initFromResultSet:(MCEResultSet *)resultSet

Parameters

resultSet

The resultSet parameter is a database result set object from the inAppMessage table.

Return Value

Returns a fully initialized MCEInAppMessage object.

Discussion

The initFromResultSet: method constructs a MCEInAppMessage object from a database result set.

Declared In

MCEInAppMessage.h

+ inAppMessageWithPayload:

The inAppMessageWithPayload: method allocates and constructs a MCEInAppMessage object from a APNS payload.

+ (instancetype)inAppMessageWithPayload:(NSDictionary *)payload

Parameters

payload

An APNS payload containing an MCEInAppMessage definition.

Return Value

Returns a fully allocatated and initialized MCEInAppMessage object.

Discussion

The inAppMessageWithPayload: method allocates and constructs a MCEInAppMessage object from a APNS payload.

Declared In

MCEInAppMessage.h

– initWithPayload:

The initWithPayload: method constructs a MCEInAppMessage object from a APNS payload.

- (instancetype)initWithPayload:(NSDictionary *)payload

Parameters

payload

An APNS payload containing an MCEInAppMessage definition.

Return Value

Returns a fully initialized MCEInAppMessage object.

Discussion

The initWithPayload: method constructs a MCEInAppMessage object from a APNS payload.

Declared In

MCEInAppMessage.h

– isTriggered

The isTriggered method returns TRUE if the current date is greater than the triggerDate property value and FALSE otherwise.

- (BOOL)isTriggered

Discussion

The isTriggered method returns TRUE if the current date is greater than the triggerDate property value and FALSE otherwise.

Declared In

MCEInAppMessage.h

– isExpired

The isExpired method returns TRUE if the current date is greater than the expirationDate property value and FALSE otherwise.

- (BOOL)isExpired

Discussion

The isExpired method returns TRUE if the current date is greater than the expirationDate property value and FALSE otherwise.

Declared In

MCEInAppMessage.h

– isOverViewed

The isOverViewed method returns TRUE if the numViews property is larger or equal to the maxViews property and FALSE otherwise.

- (BOOL)isOverViewed

Discussion

The isOverViewed method returns TRUE if the numViews property is larger or equal to the maxViews property and FALSE otherwise.

Declared In

MCEInAppMessage.h

– rulesData

The rulesData method returns the rules property as an NSData object for archiving.

- (NSData *)rulesData

Return Value

Returns an NSData object representing the rules array.

Discussion

The rulesData method returns the rules property as an NSData object for archiving.

Declared In

MCEInAppMessage.h

– contentData

The contentData method returns the content property as an NSData object for archiving.

- (NSData *)contentData

Return Value

Returns an NSData object representing the content dictionary.

Discussion

The contentData method returns the content property as an NSData object for archiving.

Declared In

MCEInAppMessage.h

– execute

The execute method queries the MCEInAppTemplateRegistry for a template to display the in-app message and tells the template object to display the message. It returns TRUE if it is finds a template object to display the message and FALSE otherwise.

- (BOOL)execute

Discussion

The execute method queries the MCEInAppTemplateRegistry for a template to display the in-app message and tells the template object to display the message. It returns TRUE if it is finds a template object to display the message and FALSE otherwise.

Declared In

MCEInAppMessage.h

Other Methods

  inAppMessageId

The inAppMessageId property is a unique identifier for in app messages.

@property NSString *inAppMessageId

Discussion

The inAppMessageId property is a unique identifier for in app messages.

Declared In

MCEInAppMessage.h

  maxViews

The maxViews property defines the maxiumum number of times a message can be viewed, after which it is deleted.

@property NSInteger maxViews

Discussion

The maxViews property defines the maxiumum number of times a message can be viewed, after which it is deleted.

Declared In

MCEInAppMessage.h

  numViews

The numViews property defines the current view count for a message.

@property NSInteger numViews

Discussion

The numViews property defines the current view count for a message.

Declared In

MCEInAppMessage.h

  templateName

The template property defines the registered template that displays this message.

@property NSString *templateName

Discussion

The template property defines the registered template that displays this message.

Declared In

MCEInAppMessage.h

  content

The content property defines the content of the message. Its structure and values are defined by the developer of the template that displays the message.

@property NSDictionary *content

Discussion

The content property defines the content of the message. Its structure and values are defined by the developer of the template that displays the message.

Declared In

MCEInAppMessage.h

  triggerDate

The triggerDate property defines when the message can be initially displayed to the user. After this date, the message is displayed in listings of available messages. Before this date, the message is not displayed in listings of available messages.

@property NSDate *triggerDate

Discussion

The triggerDate property defines when the message can be initially displayed to the user. After this date, the message is displayed in listings of available messages. Before this date, the message is not displayed in listings of available messages.

Declared In

MCEInAppMessage.h

  expirationDate

The expirationDate property defines the availability end date for displaying the message. After the date, the message is not displayed in listings of available messages.

@property NSDate *expirationDate

Discussion

The expirationDate property defines the availability end date for displaying the message. After the date, the message is not displayed in listings of available messages.

Declared In

MCEInAppMessage.h

  rules

The rules property defines the specific keyword rules that contain this message.

@property NSArray *rules

Discussion

The rules property defines the specific keyword rules that contain this message.

Declared In

MCEInAppMessage.h

  attribution

The attribution property represents the attribution from the original push message.

@property NSString *attribution

Discussion

The attribution property represents the attribution from the original push message.

Declared In

MCEInAppMessage.h