PWMSGZoneMessage Class Reference

Inherits from	NSObject
Conforms to	NSCopying NSSecureCoding
Declared in	PWMSGZoneMessage.h

Overview

A PWZoneMessage is a communication (generally marketing-related) sent from the server.

`alertTitle`

Returns the alert title of this message. This property will never return a nil value.

@property (readonly) NSString *alertTitle

Return Value

The alert title of this message.

Declared In

PWMSGZoneMessage.h

`alertBody`

Returns the alert body of this message. This property will never return a nil value.

@property (readonly) NSString *alertBody

Return Value

The alert body of this message.

Declared In

PWMSGZoneMessage.h

`promotionTitle`

Returns the promotion title of this message. This property will never return a nil value.

@property (readonly) NSString *promotionTitle

Return Value

The promotion title of this message.

Declared In

PWMSGZoneMessage.h

`promotionBody`

Returns the promotion body of this message. The value returned by this method is usually HTML. This property will never return a nil value.

@property (readonly) NSString *promotionBody

Return Value

The body of this message.

Discussion

To mark this message as read, pass this message to the PWLPZoneMessageManager readMessage: method.

Declared In

PWMSGZoneMessage.h

`metaData`

Returns the metadata associated with the message.

@property (readonly) NSDictionary *metaData

Return Value

Returns the metadata of this message.

Discussion

This property will never return a nil value.. It will return an empty NSDictionary object if there is no metadata associated with the message.

Declared In

PWMSGZoneMessage.h

`identifier`

Returns the internal unique identifier of the message. This identifier also idenfities the campaign this message was sent for.

@property (readonly) NSString *identifier

Return Value

The internal unique identifier message.

Discussion

There can be at most one message associated with a campaign at any given time. This property will never return a nil value.

Declared In

PWMSGZoneMessage.h

`isRead`

A Boolean value indicating whether or not the entry is read.

@property (readonly) BOOL isRead

Return Value

A Boolean value indicating whether or not the message has been read.

Discussion

A message is only considered read if it has been marked as such by the application. To mark this message as read, pass this message to the PWLPZoneMessageManager readMessage: method.

Declared In

PWMSGZoneMessage.h

`campaignType`

A string containing the campaign type of the message.

@property (readonly) NSString *campaignType

Return Value

A string containing the campaign type of the message.

Declared In

PWMSGZoneMessage.h

`– remove`

Deletes this message.

- (void)remove

Declared In

PWMSGZoneMessage.h

`– read`

Marks this message as read.

- (void)read

Declared In

PWMSGZoneMessage.h