com.captainup.android.framework

Interface Inbox

public interface Inbox

Allows to query and mark as messages as read of the user's inbox.

Method Summary

Modifier and Type	Method and Description
void	addListener(CaptainUpInboxListener listener)
void	checkForNewMessages() Checks if there are any new unread messages and updates the inbox accordingly.
int	getNewMessageCount()
void	markAllAsRead() Marks all of the user's inbox as read .
void	markMessageAsRead(java.lang.String messageID) Marks a selected message of the user's inbox as read .
void	query(Query query, CaptainUpListCallback<InboxItem> callback) Retrieves the user's inbox given a query.
void	removeListener(CaptainUpInboxListener listener)

Method Detail

addListener

void addListener(CaptainUpInboxListener listener)

removeListener

void removeListener(CaptainUpInboxListener listener)

query

void query(Query query,
           CaptainUpListCallback<InboxItem> callback)

Retrieves the user's inbox given a query.

Parameters:

query - query parameters. To create a query object use QueryBuilder

callback - a callback that will contain the response and any exception that might have risen during the execution.

getNewMessageCount

int getNewMessageCount()

checkForNewMessages

void checkForNewMessages()

Checks if there are any new unread messages and updates the inbox accordingly. This method check with the Captain Up Servers asynchronously and will notify it is done using a listener. Every subsequent calls to query(Query, CaptainUpListCallback) will be based on these results (meaning, which Inbox Item is unread. Do not call this method if you configured the Captain Up Framework to periodically check for Inbox updates. To set up periodic updates, specify a positive integer value for the key "inbox_update_period" in the Captain Up Configuration file. If you did not configure automatic update of the Inbox, make sure you call this method before calling query.

markAllAsRead

void markAllAsRead()

Marks all of the user's inbox as read . This method is asynchronous. In case of an error, an error will be raised as an event to the inbox's error listeners.

markMessageAsRead

void markMessageAsRead(java.lang.String messageID)

Marks a selected message of the user's inbox as read . This method is asynchronous. In case of an error, an error will be raised as an event to the inbox's error listeners.