Marigold Mobile Android SDK - 22.0.0/com.marigold.sdk/MessageStream

MessageStream

class MessageStream

Class to handle interactions with in-app message stream.

Constructors

MessageStream

constructor()

Types

Companion

object Companion

MessageDeletedHandler

interface MessageDeletedHandler

Handler interface for deleting a Message.

MessagesHandler

interface MessagesHandler

Handler interface for getting Messages for this device.

MessagesReadHandler

interface MessagesReadHandler

Handler interface for setting messages as read.

MessageStreamHandler

interface MessageStreamHandler<T>

Generic handler for async calls to the Marigold SDK.

OnInAppNotificationDisplayListener

fun interface OnInAppNotificationDisplayListener

Properties

messageReadFlow

val MessageStream.messageReadFlow: SharedFlow<Pair<Context, Message>>

Message Read Flow - subscribe to this to handle events when messages are read on the device.

unreadMessageCountFlow

val MessageStream.unreadMessageCountFlow: SharedFlow<Pair<Context, Int>>

Unread Message Count Flow - subscribe to this to handle events when the message unread count is updated on the device.

Functions

addMessageReadListener

fun addMessageReadListener(listener: MessageReadListener)

Add a listener to handle when messages are read by the user.

addUnreadMessageCountListener

fun addUnreadMessageCountListener(listener: UnreadMessageCountListener)

Add a listener to handle when the unread message count is updated.

clearMessages

fun clearMessages(handler: MessageStream.MessageStreamHandler<Void?>?)

Clear the Message Stream for the device.

clearMessages

suspend fun MessageStream.clearMessages()

Clear the Message Stream for the device.

clearMessagesResult

suspend fun MessageStream.clearMessagesResult(): Result<Unit>

Clear the Message Stream for the device.

deleteMessage

fun deleteMessage(message: Message, handler: MessageStream.MessageDeletedHandler?)

Removes a Message from appearing in a device's message stream. Does nothing if message is null.

deleteMessage

suspend fun MessageStream.deleteMessage(message: Message)

Removes a Message from appearing in a device's message stream.

deleteMessageResult

suspend fun MessageStream.deleteMessageResult(message: Message): Result<Unit>

Removes a Message from appearing in a device's message stream.

getMessage

fun getMessage(messageId: String, messageHandler: MessageStream.MessageStreamHandler<Message>?)

Retrieves a Message for a given Message ID.

getMessage

suspend fun MessageStream.getMessage(messageId: String): Message

Retrieves a Message for a given Message ID.

getMessageResult

suspend fun MessageStream.getMessageResult(messageId: String): Result<Message>

Retrieves a Message for a given Message ID.

getMessages

fun getMessages(messagesHandler: MessageStream.MessagesHandler?)

Retrieve all Messages visible for this device.

getMessages

suspend fun MessageStream.getMessages(): ArrayList<Message>

Retrieve all Messages visible for this device.

getMessagesResult

suspend fun MessageStream.getMessagesResult(): Result<ArrayList<Message>>

Retrieve all Messages visible for this device.

getUnreadMessageCount

fun getUnreadMessageCount(handler: MessageStream.MessageStreamHandler<Int>?)

Asynchronously returns the total number of unread messages in the message stream.

getUnreadMessageCount

suspend fun MessageStream.getUnreadMessageCount(): Int

Get the total number of unread messages in the message stream.

getUnreadMessageCountResult

suspend fun MessageStream.getUnreadMessageCountResult(): Result<Int>

Get the total number of unread messages in the message stream.

registerMessageImpression

fun registerMessageImpression(type: ImpressionType, message: Message)

Creates an impression for a message for a given interaction type.

setInAppOnClickListener

fun setInAppOnClickListener(listener: InAppNotificationTappedListener?)

Set the listener to handle taps on the in-app notification banner

setMessageRead

fun setMessageRead(message: Message, handler: MessageStream.MessagesReadHandler?)

Convenience method for setMessagesRead().

setMessageRead

suspend fun MessageStream.setMessageRead(message: Message)

Convenience method for setMessagesRead.

setMessageReadResult

suspend fun MessageStream.setMessageReadResult(message: Message): Result<Unit>

Convenience method for setMessagesRead.

setMessagesRead

fun setMessagesRead(messages: List<Message>, handler: MessageStream.MessagesReadHandler?)

Marks all given messages as read and triggers an update broadcast to the unread messages count.

setMessagesRead

suspend fun MessageStream.setMessagesRead(messages: List<Message>)

Marks all given messages as read and triggers an update broadcast to the unread messages count.

setMessagesReadResult

suspend fun MessageStream.setMessagesReadResult(messages: List<Message>): Result<Unit>

Marks all given messages as read and triggers an update broadcast to the unread messages count.

setOnInAppNotificationDisplayListener

fun setOnInAppNotificationDisplayListener(listener: MessageStream.OnInAppNotificationDisplayListener)

Set the listener to handle In-App notification on display callbacks.

setUnreadMessageCount

fun setUnreadMessageCount(unreadMessageCount: Int)