CoreConversation

data class CoreConversation(val identifier: UUID, val developerName: String, val participants: List<CoreParticipant>, val createdAt: Long? = null, val endedAt: Long? = null, val inboundHighWatermarkEntry: ConversationEntry? = null, val outboundHighWatermarkEntry: ConversationEntry? = null, val preChatFields: List<PreChatField>? = null, val activeParticipants: List<Participant> = emptyList(), val lastActivity: ConversationEntry? = null, val preChatSubmissionTimestamp: Long? = null, val termsAndConditions: TermsAndConditions? = null, val unreadMessageCount: Int = 0, val activeModalities: List<Modality> = listOf(Modality.Messaging), val modalityTransitionType: ModalityTransitionType? = null, val supportedModalities: List<Modality> = listOf(Modality.Messaging)) : Conversation

Data for a conversation entity.

See also

Constructors

Link copied to clipboard
constructor(identifier: UUID, developerName: String, participants: List<CoreParticipant>, createdAt: Long? = null, endedAt: Long? = null, inboundHighWatermarkEntry: ConversationEntry? = null, outboundHighWatermarkEntry: ConversationEntry? = null, preChatFields: List<PreChatField>? = null, activeParticipants: List<Participant> = emptyList(), lastActivity: ConversationEntry? = null, preChatSubmissionTimestamp: Long? = null, termsAndConditions: TermsAndConditions? = null, unreadMessageCount: Int = 0, activeModalities: List<Modality> = listOf(Modality.Messaging), modalityTransitionType: ModalityTransitionType? = null, supportedModalities: List<Modality> = listOf(Modality.Messaging))

Properties

Link copied to clipboard
open override val activeModalities: List<Modality>

The communication modalities currently active in this conversation (e.g., messaging, voice, video).

Link copied to clipboard
open override val activeParticipants: List<Participant>

The Participants currently active in this conversation.

Link copied to clipboard
open override val createdAt: Long?

The timestamp when the conversation was created, in milliseconds since the epoch. Null if unknown.

Link copied to clipboard
open override val developerName: String

The developer name of the embedded service deployment associated with this conversation.

Link copied to clipboard
open override val endedAt: Long?

The timestamp when the conversation was closed, in milliseconds since the epoch. Null if still open.

Link copied to clipboard
open override val identifier: UUID

The unique identifier for this conversation.

Link copied to clipboard

The last entry received from another participant that was marked as read by the local client.

Link copied to clipboard
open override val lastActivity: ConversationEntry?

The most recent ConversationEntry in this conversation.

Link copied to clipboard

The type of modality transition currently in progress, or null if none.

Link copied to clipboard

The last entry sent by the local client that was marked as read by at least one other participant.

Link copied to clipboard
open override val participants: List<CoreParticipant>

All Participants that have joined this conversation, including inactive ones.

Link copied to clipboard
open override val preChatFields: List<PreChatField>?

The pre-chat fields configured for this conversation. Null if pre-chat is not configured.

Link copied to clipboard
open override val preChatSubmissionTimestamp: Long?

The time the pre-chat form was last submitted, in milliseconds since the epoch. Null if not submitted.

Link copied to clipboard

The current lifecycle status of this conversation, derived from createdAt and endedAt.

Link copied to clipboard
open override val supportedModalities: List<Modality>

The communication modalities supported by this conversation's deployment configuration.

Link copied to clipboard

The terms and conditions configuration. Null if not configured for this deployment.

Link copied to clipboard
open override val unreadMessageCount: Int

The number of messages not yet read by the local participant. Only counts messages from non-local, non-system participants with entry type ConversationEntryType.Message.