Types

Link copied to clipboard
@JsonClass(generateAdapter = true)
class AcknowledgeDeliveryPayload(val id: String, val acknowledgedConversationEntryIdentifier: String, val acknowledgementTimestamp: Long) : EntryPayload

The delivery acknowledgement payload.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class AcknowledgeReadPayload(val id: String, val acknowledgedConversationEntryIdentifier: String, val acknowledgementTimestamp: Long) : EntryPayload

The read acknowledgement payload.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class CloseConversationPayload(val id: String, @Json(name = "conversationIdentifier") val conversationId: UUID) : EntryPayload

The read acknowledgement payload.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class MessagePayload(val id: String, val abstractMessage: Message, val messageReason: MessageReason? = null, val identifier: String = id, val wasRevised: Boolean? = null) : Message, EntryPayload
Link copied to clipboard
@JsonClass(generateAdapter = true)
class MessageUpdatedPayload(val id: String, val updatedMessage: Message) : EntryPayload

The message updated payload. Used for asynchronous updates to messages, such as attachment upload status.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class ParticipantChangedPayload(val id: String, var entries: List<ParticipantChangedEntry>) : EntryPayload

The participant changed payload.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class ProgressIndicatorPayload(val id: String, val progressIndicator: ProgressIndicator) : EntryPayload

The progress indicator payload.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class QueuePositionPayload(val id: String, val pendingServiceRoutingId: String, val workItemId: String, val position: Int) : EntryPayload

The queue position payload.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class RoutingResultPayload(val id: String, val recordId: String? = null, val failureType: RoutingFailureType, val routingType: RoutingType, val failureReason: String? = null, val estimatedWaitTime: EstimatedWaitTime? = null) : EntryPayload

The routing result payload.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class RoutingWorkResultPayload(val id: String, val workType: RoutingWorkType) : EntryPayload

The routing work result payload.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class SessionContextPayload(val id: String, val sessionContext: SessionContext) : EntryPayload

The session context payload.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class SessionStatusChangedPayload(val id: String, val sessionId: String, val channelAddressIdentifier: String, @Json(name = "conversationIdentifier") val conversationId: UUID, val sessionStatus: SessionStatus, val sessionStartTime: Long, val sessionStatusPrev: SessionStatus? = null, val sessionEndTime: Long? = null, val sessionEndedByRole: String? = null) : EntryPayload

The session status changed payload.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class StreamingTokenPayload(val id: String, val streamingToken: StreamingToken, val relatedStreamingTokens: List<StreamingToken>? = null) : EntryPayload

The streaming token payload.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class TypingIndicatorPayload(val id: String, val startedTimestamp: Long) : EntryPayload

The typing indicator payload.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class TypingStartedIndicatorPayload(val id: String, val timestamp: Long) : EntryPayload

The typing started indicator payload.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class TypingStoppedIndicatorPayload(val id: String, val timestamp: Long) : EntryPayload

The typing stopped indicator payload.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class UnknownEntryPayload(val id: String) : EntryPayload

The unknown entry payload.

Properties

Link copied to clipboard

The entry type for the conversation entry.

Link copied to clipboard
abstract val id: String

The conversation entry ID.