Conversation

Container for conversation object.

To obtain a Conversation call createConversation, getConversation or get it from collections returned by getMyConversations.

Conversation is a relatively heavy-weight object. It receives state updates from the back-end in real time.

Types

ConversationState

enum ConversationState

Represents the various states of the conversation.

ConversationStatus

enum ConversationStatus

Represents the various statuses of the user with respect to the conversation.

MessageBuilder

interface MessageBuilder

Builder for preparing new message.

NotificationLevel

enum NotificationLevel

User's notification level on a conversation.

SynchronizationStatus

enum SynchronizationStatus

Indicates synchronization status for conversation.

UnsentMessage

interface UnsentMessage

Unsent message which is ready for sending.

UpdateReason

enum UpdateReason

Indicates reason for conversation update.

Functions

addListener

abstract fun addListener(listener: ConversationListener)

Add a new ConversationListener for this Conversation.

addParticipantByAddress

abstract fun addParticipantByAddress(address: String, proxyAddress: String, attributes: Attributes, listener: StatusListener)

Add specified non chat participant to this conversation (sms, whatsapp participants etc).

addParticipantByIdentity

abstract fun addParticipantByIdentity(identity: String, attributes: Attributes, listener: StatusListener)

Add the participant with the specified username to this conversation.

advanceLastReadMessageIndex

abstract fun advanceLastReadMessageIndex(lastReadMessageIndex: Long, listener: CallbackListener<Long>)

Increase user last read message index for the conversation.

destroy

abstract fun destroy(listener: StatusListener)

Destroy the current conversation.

getAttributes

abstract fun getAttributes(): Attributes

Get custom attributes associated with the Conversation.

getCreatedBy

abstract fun getCreatedBy(): String

Get creator of the conversation.

getDateCreated

abstract fun getDateCreated(): String

Get creation date of the conversation as an ISO 8601 string.

getDateCreatedAsDate

abstract fun getDateCreatedAsDate(): Date

Get creation date of the conversation.

getDateUpdated

abstract fun getDateUpdated(): String

Get update date of the conversation as an ISO 8601 string.

getDateUpdatedAsDate

abstract fun getDateUpdatedAsDate(): Date

Get update date of the conversation.

getFriendlyName

abstract fun getFriendlyName(): String

Get friendly name of the conversation.

getLastMessageDate

abstract fun getLastMessageDate(): Date

Get last message date in the conversation.

getLastMessageIndex

abstract fun getLastMessageIndex(): Long

Get last message's index in the conversation.

getLastMessages

abstract fun getLastMessages(count: Int, listener: CallbackListener<List<Message>>)

Load last messages in conversation.

getLastReadMessageIndex

abstract fun getLastReadMessageIndex(): Long

Return user last read message index for the conversation.

getLimits

abstract fun getLimits(): ConversationLimits

getMessageByIndex

abstract fun getMessageByIndex(index: Long, listener: CallbackListener<Message>)

Get message object by known index.

getMessagesAfter

abstract fun getMessagesAfter(index: Long, count: Int, listener: CallbackListener<List<Message>>)

Fetch at most count messages including and subsequent to the specified index.

getMessagesBefore

abstract fun getMessagesBefore(index: Long, count: Int, listener: CallbackListener<List<Message>>)

Fetch at most count messages including and prior to the specified index.

getMessagesCount

abstract fun getMessagesCount(listener: CallbackListener<Long>)

Get total number of messages in the conversation.

getNotificationLevel

abstract fun getNotificationLevel(): Conversation.NotificationLevel

The current user's notification level on this conversation.

getParticipantByIdentity

abstract fun getParticipantByIdentity(identity: String): Participant

Get a conversation participant by identity.

getParticipantBySid

abstract fun getParticipantBySid(sid: String): Participant

Get a conversation participant by sid.

getParticipantsCount

abstract fun getParticipantsCount(listener: CallbackListener<Long>)

Get total number of participants in the conversation roster.

getParticipantsList

abstract fun getParticipantsList(): List<Participant>

Obtain an array of participants of this conversation.

getSid

abstract fun getSid(): String

Get unique identifier for this conversation.

getState

abstract fun getState(): Conversation.ConversationState

Get activity state of this conversation.

getStateDateUpdatedAsDate

abstract fun getStateDateUpdatedAsDate(): Date

Get update date of the ConversationState

getStatus

abstract fun getStatus(): Conversation.ConversationStatus

Get the current user's participation status on this conversation.

getSynchronizationStatus

abstract fun getSynchronizationStatus(): Conversation.SynchronizationStatus

Get the current synchronization status for conversation.

getUniqueName

abstract fun getUniqueName(): String

Get unique name of the conversation.

getUnreadMessagesCount

abstract fun getUnreadMessagesCount(listener: CallbackListener<Long>)

Get number of unread messages in the conversation.

join

abstract fun join(listener: StatusListener)

Join the current user to this conversation.

leave

abstract fun leave(listener: StatusListener)

Leave this conversation.

prepareMessage

abstract fun prepareMessage(): Conversation.MessageBuilder

Prepares a new message to send into the conversation.

removeAllListeners

abstract fun removeAllListeners()

Remove all ConversationListeners for this Conversation.

removeListener

abstract fun removeListener(listener: ConversationListener)

Remove ConversationListener for this Conversation.

removeMessage

abstract fun removeMessage(message: Message, listener: StatusListener)

Removes a message from the conversation.

removeParticipant

abstract fun removeParticipant(participant: Participant, listener: StatusListener)

Remove specified participant from this conversation.

removeParticipantByIdentity

abstract fun removeParticipantByIdentity(identity: String, listener: StatusListener)

Remove the participant with the specified identity from this conversation.

setAllMessagesRead

abstract fun setAllMessagesRead(listener: CallbackListener<Long>)

Mark all messages in conversation as read.

setAllMessagesUnread

abstract fun setAllMessagesUnread(listener: CallbackListener<Long>)

Mark all messages in conversation as unread.

setAttributes

abstract fun setAttributes(attributes: Attributes, listener: StatusListener)

Set attributes associated with this conversation.

setFriendlyName

abstract fun setFriendlyName(friendlyName: String, listener: StatusListener)

Update the friendly name for this conversation.

setLastReadMessageIndex

abstract fun setLastReadMessageIndex(lastReadMessageIndex: Long, listener: CallbackListener<Long>)

Set user last read message index for the conversation.

setNotificationLevel

abstract fun setNotificationLevel(notificationLevel: Conversation.NotificationLevel, listener: StatusListener)

Set the user's notification level for the conversation.

setUniqueName

abstract fun setUniqueName(uniqueName: String, listener: StatusListener)

Update the unique name for this conversation.

typing

abstract fun typing()

Indicate that Participant is typing in this conversation.