Im

interface Im

Instant messaging module

Types

Companion

object Companion

Functions

createNewConversationFromJid

abstract fun createNewConversationFromJid(contactJid: String): IRainbowConversation

Create a new conversation with the given contact jid.

createNewConversationFromRoom

abstract fun createNewConversationFromRoom(room: Room): IRainbowConversation

Create a new conversation with the given room.

deleteAllMessages

abstract fun deleteAllMessages(conversation: IRainbowConversation?, notification: IMamNotification?)

Delete all messages from a conversation.

deleteConversation

abstract fun deleteConversation(conversation: IRainbowConversation?, listener: IConversationProxy.IDeleteConversationListener?)

Delete a conversation from the active list of conversations.

deleteConversations

abstract fun deleteConversations(conversations: List<IRainbowConversation>?, listener: IConversationProxy.IDeleteConversationListener?)

Delete a conversation from the active list of conversations.

getConversationFromContact

abstract fun getConversationFromContact(contactJid: String): IRainbowConversation

Get the conversation from a contact jid.

getConversationFromId

abstract fun getConversationFromId(conversationId: String?): IRainbowConversation?

Get a conversation from its id.

getConversationFromJid

abstract fun getConversationFromJid(conversationJid: String?): IRainbowConversation?

Get a conversation from its jid.

getConversationFromRoom

abstract fun getConversationFromRoom(room: Room): IRainbowConversation

Get the conversation from a room.

getConversationWithContact

abstract fun getConversationWithContact(contact: IRainbowContact?): IRainbowConversation?

Get the conversation associated to the given contact if any

getMessagesFromConversation

abstract fun getMessagesFromConversation(conversation: IRainbowConversation?)

Retrieve the list of the 50 first messages of a given conversation.

abstract fun getMessagesFromConversation(conversation: IRainbowConversation?, nbMessagesToRetrieve: Int)

Retrieve the list of the nbMessagesToRetrieve first messages of a given conversation.

getMoreMessagesFromConversation

abstract fun getMoreMessagesFromConversation(conversation: IRainbowConversation?)

Retrieve the list of the 50 next messages of a given conversation.

abstract fun getMoreMessagesFromConversation(conversation: IRainbowConversation?, nbMessagesToRetrieve: Int)

Retrieve the list of the nbMessagesToRetrieve next messages of a given conversation.

getUserLastMessageSent

abstract fun getUserLastMessageSent(conversationId: String?): IMMessage?

Get the last message sent by the user in the conversation with the given id

markMessageFromConversationAsRead

abstract fun markMessageFromConversationAsRead(conversation: IRainbowConversation?, message: IMMessage?)

Mark a message from a conversation as read.

markMessagesFromConversationAsRead

abstract fun markMessagesFromConversationAsRead(conversation: IRainbowConversation?): Boolean

Mark all messages from a conversation as read.

muteOrUnmuteConversation

abstract fun muteOrUnmuteConversation(conversationId: String?, mustBeMuted: Boolean, listener: IConversationProxy.IUpdateConversationListener?)

Mute or Unmute notifications for a conversationThis method only works if the conversation already exists.

refreshConversations

abstract fun refreshConversations(listener: IConversationProxy.IGetAllConversationListener?)

Refresh the list of conversations

registerListener

abstract fun registerListener(listener: IRainbowImListener?)

Register to the listener with following triggers: onImReceived, onImSent, isTypingState, onMessagesListUpdated, onMoreMessagesListUpdated

sendConversationByEmail

abstract fun sendConversationByEmail(conversation: IRainbowConversation, email: String, notification: IConversationProxy.ISendConversationByEmailListener?)

Send all messages from a conversation to the user email.

sendConversationByEmails

abstract fun sendConversationByEmails(conversation: IRainbowConversation, emails: List<String>, notification: IConversationProxy.ISendConversationByEmailListener?)

Send all messages from a conversation to a list of emails.

sendIsTyping

abstract fun sendIsTyping(conversation: IRainbowConversation?, state: ChatState)

Send or not the status isTyping depending on the parameter.

sendMessageToConversation

abstract fun sendMessageToConversation(conversation: IRainbowConversation?, imMessage: IMMessage?)

Send a message to a given conversation with a file.

abstract fun sendMessageToConversation(conversation: IRainbowConversation?, message: String)

Send a message to a given conversation.

abstract fun sendMessageToConversation(conversation: IRainbowConversation?, fileDescriptor: RainbowFileDescriptor?, message: String)

Send a message to a given conversation with a file.

abstract fun sendMessageToConversation(conversation: IRainbowConversation?, message: String?, additionalContents: List<AdditionalContent>)

Send a message to a given conversation with a list of additional contents

abstract fun sendMessageToConversation(conversation: IRainbowConversation?, message: String?, additionalMessageType: String?, additionalMessageContent: String?)

Send a message to a given conversation with a single additional content

unregisterListener

abstract fun unregisterListener(listener: IRainbowImListener?)

Unregister to the listener with following triggers: onImReceived, onImSent, isTypingState, onMessagesListUpdated, onMoreMessagesListUpdated

Properties

allConversations

abstract val allConversations: ArrayItemList<IRainbowConversation>

Get all the conversations of the user in an ArrayItemList.

totalUnreadMsgNb

abstract val totalUnreadMsgNb: Int

Get the total count of unread messages