platform_messaging_api_common_model/com.tomtom.ivi.platform.messaging.api.common.model/MessagingProviderHelper

MessagingProviderHelper

Helper class that provides all common functionality that is needed by messaging providers.

For example a messaging provider service can be initialized like this:

class StockSmsService(
  iviServiceHostContext: IviServiceHostContext,
  serviceIdProvider: IviDiscoverableServiceIdProvider
) : MessagingProviderServiceBase(iviServiceHostContext, serviceIdProvider) {
  // ...

  private val messagingProviderHelper = MessagingProviderHelper().also {
    conversationsForProvider = it.conversations
    messageTypesForProvider = it.messageTypes
    it.registerSendMessageCallback { conversation, message ->
      sendMessage(conversation, message)
    }
  }

  // ...
}

Constructors

fun MessagingProviderHelper()

Properties

conversations

val conversations: MirrorableMap<Uid<Conversation>, Conversation>

The conversations.

messageTypes

val messageTypes: MirrorableMap<MessageType, Boolean>

The message types supported by the provider.

Functions

addOrUpdateAllConversations

fun addOrUpdateAllConversations(conversations: Map<Uid<Conversation>, Conversation>)

Adds or updates the specified conversations.

addOrUpdateAllMessages

fun addOrUpdateAllMessages(messages: Collection<Message>)

Adds or updates all the specified messages.

addOrUpdateConversation

fun addOrUpdateConversation(conversation: Conversation)

Adds or updates the specified conversation. Note that Conversation.unreadMessages will be ignored. Messages can only be added by using addOrUpdateMessage.

addOrUpdateMessage

fun addOrUpdateMessage(message: Message): Boolean

Adds or updates the specified message.

findConversation

fun findConversation(contacts: Set<ConversationContact>, messageType: MessageType, source: ConversationSource?): Conversation?

Finds a conversation originating from the source that has the specified contacts and the specified messageType. If source is null, the source field is ignored.

findMessageById

fun findMessageById(messageId: Uid<Message>): Message?

Finds the message with the specified messageId in all conversations.

findOrCreateConversation

fun findOrCreateConversation(contacts: Set<ConversationContact>, messageType: MessageType, source: ConversationSource?, applicationDisplayName: StringResolver, conversationCapabilities: EnumSet<ConversationCapability>): Conversation

Finds a conversation originating from the source that has the specified contacts and the specified messageType. Otherwise, creates and adds a new conversation with the specified parameters.

markConversationReadUpToAndIncluding

fun markConversationReadUpToAndIncluding(conversationId: Uid<Conversation>, messageId: Uid<Message>): Boolean

Marks all messages up to and including the message with the specified messageId as read for the conversation with the specified conversationId.

registerSendMessageCallback

fun registerSendMessageCallback(callback: SendMessageCallback): SendMessageCallback?

Registers the specified callback to be called when a message is added with the MessageState.OUTGOING_QUEUED state. This will replace a previously registered callback.

removeAllMessages

fun removeAllMessages(conversationId: Uid<Conversation>, messageIds: Collection<Uid<Message>>)

Removes all messages with specified messageIds from the conversation with the specified conversationId.

removeConversation

fun removeConversation(conversationId: Uid<Conversation>): Conversation?

Removes the conversation with the specified conversationId.

retainAllConversations

fun retainAllConversations(conversationIds: Collection<Uid<Conversation>>)

Retains only the conversations with the specified conversationIds. Removes the remaining conversations.

retainAllMessages

fun retainAllMessages(messageIds: Collection<Uid<Message>>)

Retains only the messages with the specified messageIds. Removes the remaining messages.

setMessageTypeEnabled

fun setMessageTypeEnabled(messageType: MessageType, enabled: Boolean)

Enables or disables the specified messageType according to the specified enabled parameter.