com.captainup.android.framework

Interface InboxItem

All Superinterfaces:

CaptainUpObject

public interface InboxItem
extends CaptainUpObject

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.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContent() The item's message.
java.lang.String	getContentHTML() The items' message in HTML format.
java.util.Map<java.lang.String,Currency>	getCurrencies() The currencies awarded (or reduced) from the user as part of the message.
java.lang.String	getID()
java.lang.String	getShortContent() Get the message short description text.
java.util.Date	getTimestamp() The time at which the message was sent.
java.lang.String	getTitle() Get the message title
boolean	isUnread() Was this message read before or not.

Method Detail

getID

java.lang.String getID()

getContent

java.lang.String getContent()

The item's message.

Returns:

the item's message. May be null.

getContentHTML

java.lang.String getContentHTML()

The items' message in HTML format.

Returns:

the items' message in HTML format. May be null

getTimestamp

java.util.Date getTimestamp()

The time at which the message was sent.

Returns:

the time the message was sent.

getCurrencies

java.util.Map<java.lang.String,Currency> getCurrencies()

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.

isUnread

boolean isUnread()

Was this message read before or not.

Returns:

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

See Also:

Inbox.markAllAsRead()

getTitle

java.lang.String getTitle()

Get the message title

Returns:

the message title

getShortContent

java.lang.String getShortContent()

Get the message short description text.

Returns:

short content