chat-core/dev.hatang.chat.core.http

Package-level declarations

Types

data class ConversationPage(val conversations: List<VisitorConversationDto>, val hasMore: Boolean)

A page of the visitor's conversations.

data class DeviceRegistration(val token: String, val provider: PushProvider, val platform: String, val installId: String? = null, val locale: String? = null, val appVersion: String? = null, val osVersion: String? = null, val deviceModel: String? = null)

A device registered for pushes.

LeadResult

data class LeadResult(val conversationId: String?, val visitorId: String?)

Reply to leads.

MessagesPage

data class MessagesPage(val items: List<TimelineItem>, val hasMore: Boolean)

A page of timeline items.

OfflineMessageResult

data class OfflineMessageResult(val conversation: ConversationSummary, val messageId: String)

Reply to the offline form.

ResetResult

data class ResetResult(val visitorToken: String, val visitorId: String)

Reply to reset.

RestoreResult

data class RestoreResult(val visitorToken: String, val visitorId: String, val conversationId: String, val conversation: ConversationSummary? = null)

Reply to sessions/restore.

SendResult

data class SendResult(val id: String, val seq: Int, val duplicate: Boolean)

Reply to the HTTP send fallback.

UploadProgress

typealias UploadProgress = (sent: Long, total: Long) -> Unit

Called as an upload body streams out: sent of total bytes (on an OkHttp thread).

WidgetApi

open class WidgetApi(baseUrl: String, val siteId: String, val appKey: String, val userAgent: String, client: OkHttpClient? = null, val timeout: Duration = 20.seconds)

The visitor REST API (/widget/v1/sites/{siteId}/…) over OkHttp. Every call sends the app key and the user agent; token calls add x-visitor-token. Failures throw HatangException: gateway errors ({statusCode, name, message}) keep their name as HatangException.code and the HTTP status; transport failures are network_error. Open so tests can script it.

Properties

APP_KEY_HEADER

const val APP_KEY_HEADER: String

Header carrying the site app key.

VISITOR_TOKEN_HEADER

const val VISITOR_TOKEN_HEADER: String

Header carrying the visitor token.