chat-core/dev.hatang.chat.core.state

Package-level declarations

Types

class ChatEngine(api: WidgetApi, connector: SocketConnector, store: SessionStore, appInfo: HatangAppInfo, logger: HatangLogger = HatangLogger.SILENT, preferredLocale: String? = null, backoff: Backoff = Backoff(), val backgroundCloseDelay: Duration = 10.seconds, val typingIdle: Duration = 3.seconds, val bootstrapRetry: Duration = 5.seconds, val openOnProactiveMessage: Boolean = true, clock: HatangClock = HatangClock.SYSTEM, scope: CoroutineScope? = null, dispatcher: CoroutineDispatcher = Dispatchers.Default)

The chat state machine: bootstrap → connect → ready → frames, plus every host-facing action. Pure Kotlin/JVM; the Android module wires storage, lifecycle and UI around it.

ChatPhase

enum ChatPhase : Enum<ChatPhase>

Where the engine is in its life.

ChatState

data class ChatState(val phase: ChatPhase = ChatPhase.IDLE, val connection: HatangConnectionState = HatangConnectionState.DISCONNECTED, val config: SiteConfig? = null, val visitor: VisitorDto? = null, val conversation: ConversationSummary? = null, val timeline: Timeline = Timeline.EMPTY, val pending: List<PendingMessage> = emptyList(), val typingAgent: String? = null, val availability: Availability = Availability.OFFLINE, val unread: Int = 0, val locale: HatangLocale = HatangLocale.VI, val needsEmail: Boolean = false, val skippedEmail: Boolean = false, val rated: Int? = null, val transientError: HatangException? = null, val outdatedReason: String? = null, val visitorEmail: String? = null, val visitorName: String? = null, val loadingEarlier: Boolean = false, val visible: Boolean = false, val foreground: Boolean = true, val draft: String? = null)

Immutable snapshot of everything the UI renders (ChatEngine.state).

HatangClosed

data object HatangClosed : HatangEvent

The chat screen was dismissed (emitted by the UI layer).

HatangConnectionState

enum HatangConnectionState : Enum<HatangConnectionState>

Socket connection state as exposed to hosts.

HatangConversationStatus

data class HatangConversationStatus(val conversationId: String, val status: ConversationStatus) : HatangEvent

The conversation's status changed.

HatangConversion

data class HatangConversion(val kind: HatangConversionKind, val data: Map<String, Any?> = emptyMap()) : HatangEvent

A conversion the host may forward to its analytics.

HatangConversionKind

enum HatangConversionKind : Enum<HatangConversionKind>

Kinds of conversion the SDK reports.

HatangEvent

sealed class HatangEvent

Something a host app may react to (ChatEngine.events).

HatangMessageReceived

data class HatangMessageReceived(val message: MessageDto) : HatangEvent

A message from the team, bot or system arrived.

HatangMessageSent

data class HatangMessageSent(val message: MessageDto) : HatangEvent

A message from this visitor was stored (echo, possibly from another device).

HatangOpened

data object HatangOpened : HatangEvent

The chat screen was shown (emitted by the UI layer).

HatangProtocolOutdated

data class HatangProtocolOutdated(val reason: String) : HatangEvent

The gateway no longer speaks this SDK's protocol version; ship an update.

HatangReady

data class HatangReady(val visitorId: String, val conversationId: String? = null) : HatangEvent

Bootstrapped and authenticated; the conversation (if any) is loaded.

HatangSession

data class HatangSession(val locale: HatangLocale, val visitorId: String? = null, val conversationId: String? = null, val isIdentified: Boolean = false, val email: String? = null, val name: String? = null)

A read-only view of the session for hosts.

HatangSessionChanged

data class HatangSessionChanged(val visitorId: String, val reason: HatangSessionChangeReason) : HatangEvent

The visitor identity behind this session changed.

HatangSessionChangeReason

enum HatangSessionChangeReason : Enum<HatangSessionChangeReason>

Why the session changed.

PendingMessage

data class PendingMessage(val clientId: String, val content: String, val createdAt: Instant, val attachments: List<String> = emptyList(), val upload: PendingUpload? = null, val failed: Boolean = false, val errorCode: String? = null)

An outgoing message that has no ack yet (or failed).

PendingUpload

data class PendingUpload(val source: UploadSource, val progress: Double = 0.0, val uploadedId: String? = null)

The upload behind a pending attachment message.

Timeline

data class Timeline(val items: List<TimelineItem> = emptyList(), val hasMore: Boolean = false, val lastSeq: Int = 0, val oldestSeq: Int = 0)

The loaded window of a conversation.

UploadSource

class UploadSource(val bytes: ByteArray, val name: String, val mimeType: String)

A file the visitor is sending: its bytes, name and MIME type. Built by the SDK's pickers (or by the host) and handed to ChatEngine.attach.

Properties

UPLOAD_MIME_TYPES

val UPLOAD_MIME_TYPES: Set<String>

MIME types the gateway accepts (the same list as the server's upload allow-list).

Functions

mimeTypeForName

fun mimeTypeForName(name: String): String?

MIME type for a file name, from its extension; null when the gateway would refuse it.