<CPTInboxItem> Protocol Reference

#import <CPTInboxItem.h>

Inheritance diagram for <CPTInboxItem>:

Instance Methods
(nonnull NSString *)	- getID
Instance Methods inherited from <CPTObject>
(nonnull instancetype)	- initWithDictionary:
(nonnull NSDictionary< NSString *, id > *)	- toDictionary

Properties
NSString *	content
NSString *	contentHTML
NSDate *	timestamp
NSDictionary< NSString *, id< CPTCurrency > > *	currencies
BOOL	isUnread
NSString *	title
NSString *	shortContent
NSUInteger	difficulty
NSString *	presetImage
BOOL	isNotification
NSDictionary< NSString *, id > *	customData
Properties inherited from <CPTObject>
NSDictionary< NSString *, id > *	sourceDictionary

Detailed Description

Describes a Captain Up Inbox item. The item may or may not have any content (the actual message) and may or may not award or subtract points from the user.

Property Documentation

content

- (NSString*) content

readnonatomicassign

The item's message.

Returns

the item's message. May be null.

contentHTML

- (NSString*) contentHTML

readnonatomicassign

The items' message in HTML format.

Returns

the items' message in HTML format. May be null

currencies

- (NSDictionary<NSString*,id<CPTCurrency> >*) currencies

readnonatomicassign

The currencies awarded (or reduced) from the user as part of the message. In most cases, the messages does not change the user's currencies balance, and this will return 0 for each currency.

Returns

the currencies awarded (or reduced) from the user as part of the message.

customData

- (NSDictionary<NSString*, id>*) customData

readnonatomicassign

Get the message custom data

difficulty

- (NSUInteger) difficulty

readnonatomicassign

get message difficulty

isNotification

- (BOOL) isNotification

readnonatomicassign

is this as notificaion or message

isUnread

- (BOOL) isUnread

readnonatomicassign

Was this message read before or not.

Returns

true if the message was never marked as read before, false otherwise.

See also

markAllAsRead

presetImage

- (NSString*) presetImage

readnonatomicassign

get preset image

shortContent

- (NSString*) shortContent

readnonatomicassign

Get the message short description text.

Returns

short content

timestamp

- (NSDate*) timestamp

readnonatomicassign

The time at which the message was sent.

Returns

the time the message was sent.

title

- (NSString*) title

readnonatomicassign

Get the message title

Returns

he message title

---

The documentation for this protocol was generated from the following file:

• /Users/yogs/Desktop/CaptainUp/Headers/CPTInboxItem.h