urbanairship-message-center/com.urbanairship.messagecenter/Inbox

Inbox

The inbox provides access to the device's local inbox data. Modifications (e.g., deletions or mark read) will be sent to the Airship server the next time the inbox is synchronized.

Types

FetchMessagesCallback

fun interface FetchMessagesCallback

A callback used to be notified when refreshing messages.

Properties

user

val user: User

The User.

Functions

addListener

fun addListener(listener: InboxListener)

Subscribe a listener for inbox update event callbacks.

deleteAllMessages

fun deleteAllMessages()

Mark all Messages deleted.

deleteMessages

fun deleteMessages(vararg messageIds: String)

fun deleteMessages(messageIds: Set<String>)

Mark Messages deleted.

fetchMessages

suspend fun fetchMessages(): Boolean

Suspending function to fetch the latest inbox changes from Airship.

fun fetchMessages(callback: Inbox.FetchMessagesCallback): Cancelable

fun fetchMessages(looper: Looper? = null, callback: Inbox.FetchMessagesCallback? = null): Cancelable

Fetches the latest inbox changes from Airship.

getCount

suspend fun getCount(): Int

The total message count.

getCountPendingResult

fun getCountPendingResult(): PendingResult<Int>

A PendingResult of the total message count.

getMessage

suspend fun getMessage(messageId: String?): Message?

Get the Message with the corresponding message ID.

getMessageByUrl

suspend fun getMessageByUrl(messageUrl: String?): Message?

Get the Message with the corresponding message body URL.

getMessageByUrlPendingResult

fun getMessageByUrlPendingResult(messageUrl: String?): PendingResult<Message?>

Get the Message with the corresponding message body URL as a PendingResult.

getMessageIds

suspend fun getMessageIds(): Set<String>

All the message IDs in the Inbox.

getMessageIdsPendingResult

fun getMessageIdsPendingResult(): PendingResult<Set<String>>

A PendingResult of all the message IDs in the Inbox.

getMessagePendingResult

fun getMessagePendingResult(messageId: String?): PendingResult<Message?>

Get the Message with the corresponding message ID as a PendingResult.

getMessages

suspend fun getMessages(predicate: Predicate<Message>? = null): List<Message>

Gets a list of RichPushMessages, filtered by the provided predicate, and sorted by descending sent-at date.

getMessagesFlow

fun getMessagesFlow(predicate: Predicate<Message>? = null): Flow<List<Message>>

Subscribes to the list of messages as a flow. The flow will emit the current list of messages, filtered by the provided predicate, and sorted by descending sent-at date, and will emit new lists whenever the inbox is updated.

getMessagesPendingResult

@JvmOverloads

fun getMessagesPendingResult(predicate: Predicate<Message>? = null): PendingResult<List<Message>?>

Gets a list of RichPushMessages as a PendingResult, filtered by the provided predicate, and sorted by descending sent-at date.

getReadCount

suspend fun getReadCount(): Int

The number of read messages currently in the Inbox.

getReadCountPendingResult

fun getReadCountPendingResult(): PendingResult<Int>

A PendingResult of the read message count.

getReadMessages

suspend fun getReadMessages(predicate: Predicate<Message>? = null): List<Message>

Gets a list of read RichPushMessages, filtered by the provided predicate. Sorted by descending sent-at date.

getReadMessagesPendingResult

@JvmOverloads

fun getReadMessagesPendingResult(predicate: Predicate<Message>? = null): PendingResult<List<Message>?>

Gets a list of read RichPushMessages as a PendingResult, filtered by the provided predicate, and sorted by descending sent-at date.

getUnreadCount

suspend fun getUnreadCount(): Int

The number of unread messages currently in the Inbox.

getUnreadCountPendingResult

fun getUnreadCountPendingResult(): PendingResult<Int>

A PendingResult of the unread message count.

getUnreadMessages

suspend fun getUnreadMessages(predicate: Predicate<Message>? = null): List<Message>

Gets a list of unread RichPushMessages, filtered by the provided predicate, and sorted by descending sent-at date.

getUnreadMessagesFlow

fun getUnreadMessagesFlow(predicate: Predicate<Message>? = null): Flow<List<Message>>

Subscribes to the list of unread messages as a flow. The flow will emit the current list of unread messages, filtered by the provided predicate, and sorted by descending sent-at date, and will emit new lists whenever the inbox is updated.

getUnreadMessagesPendingResult

@JvmOverloads

fun getUnreadMessagesPendingResult(predicate: Predicate<Message>? = null): PendingResult<List<Message>?>

Gets a list of unread RichPushMessages as a PendingResult, filtered by the provided predicate, and sorted by descending sent-at date.

markMessagesRead

fun markMessagesRead(vararg messageIds: String)

fun markMessagesRead(messageIds: Set<String>)

Mark Messages read in bulk.

markMessagesUnread

fun markMessagesUnread(vararg messageIds: String)

fun markMessagesUnread(messageIds: Set<String>)

Mark Messages unread in bulk.

removeListener

fun removeListener(listener: InboxListener)

Unsubscribe a listener for inbox update event callbacks.