java.lang.Object | |
↳ | com.urbanairship.richpush.RichPushInbox |
The RichPushInbox singleton provides access to the device's local inbox data. Modifications (e.g., deletions or mark read) will be sent to the Urban Airship server the next time the inbox is synchronized.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
interface | RichPushInbox.Listener | A listener interface for receiving event callbacks related to inbox database updates. |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | MESSAGE_DATA_SCHEME | Scheme used for @{code message:com.urbanairship.VIEW_RICH_PUSH_MESSAGE . |
|||||||||
String | VIEW_INBOX_INTENT_ACTION | Intent action to view the rich push inbox. | |||||||||
String | VIEW_MESSAGE_INTENT_ACTION | Intent action to view a rich push message. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
void |
addListener(RichPushInbox.Listener listener)
Subscribe a listener for inbox update event callbacks.
| ||||||||||
void |
deleteMessages(Set<String> messageIds)
Mark
RichPushMessage s deleted. | ||||||||||
int |
getCount()
Gets the total message count.
| ||||||||||
RichPushMessage |
getMessage(String messageId)
Get the
RichPushMessage with the corresponding message ID. | ||||||||||
Set<String> |
getMessageIds()
Gets all the message ids in the inbox.
| ||||||||||
List<RichPushMessage> |
getMessages()
Gets a list of RichPushMessages.
| ||||||||||
int |
getReadCount()
Gets the total read message count.
| ||||||||||
List<RichPushMessage> |
getReadMessages()
Gets a list of read RichPushMessages.
| ||||||||||
int |
getUnreadCount()
Gets the total unread message count.
| ||||||||||
List<RichPushMessage> |
getUnreadMessages()
Gets a list of unread RichPushMessages.
| ||||||||||
void |
markMessagesRead(Set<String> messageIds)
Mark
RichPushMessage s read in bulk. | ||||||||||
void |
markMessagesUnread(Set<String> messageIds)
Mark
RichPushMessage s unread in bulk. | ||||||||||
void |
removeListener(RichPushInbox.Listener listener)
Unsubscribe a listener for inbox update event callbacks.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Scheme used for @{code message:com.urbanairship.VIEW_RICH_PUSH_MESSAGE
.
Intent action to view the rich push inbox.
Intent action to view a rich push message.
Subscribe a listener for inbox update event callbacks.
listener | An object implementing the RichPushInbox.Listener interface.
|
---|
Mark RichPushMessage
s deleted.
messageIds | A set of message ids. |
---|
Gets the total message count.
Get the RichPushMessage
with the corresponding message ID.
messageId | The message ID of the desired RichPushMessage . |
---|
RichPushMessage
or null
if one does not exist.
Gets all the message ids in the inbox.
Gets a list of RichPushMessages. Sorted by descending sent at date.
RichPushMessage
s.
Gets the total read message count.
Gets a list of read RichPushMessages. Sorted by descending sent at date.
RichPushMessage
s.
Gets the total unread message count.
Gets a list of unread RichPushMessages. Sorted by descending sent at date.
RichPushMessage
s.
Mark RichPushMessage
s read in bulk.
messageIds | A set of message ids. |
---|
Mark RichPushMessage
s unread in bulk.
messageIds | A set of message ids. |
---|
Unsubscribe a listener for inbox update event callbacks.
listener | An object implementing the RichPushInbox.Listener interface.
|
---|