chat-core/dev.hatang.chat.core.protocol/BootstrapResponse

BootstrapResponse

data class BootstrapResponse(val visitorToken: String, val visitor: VisitorDto, val config: SiteConfig, val availability: Availability, val timeline: List<TimelineItem>, val wsUrl: String, val conversation: ConversationSummary? = null, val protocolVersion: Int = 1, val timelineHasMore: Boolean? = null, val appId: String? = null, val appPlatform: String? = null)

What POST /bootstrap returns.

Constructors

Link copied to clipboard
constructor(visitorToken: String, visitor: VisitorDto, config: SiteConfig, availability: Availability, timeline: List<TimelineItem>, wsUrl: String, conversation: ConversationSummary? = null, protocolVersion: Int = 1, timelineHasMore: Boolean? = null, appId: String? = null, appPlatform: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val appId: String? = null

The site app id the key resolved to.

Link copied to clipboard
val appPlatform: String? = null

The site app platform.

Link copied to clipboard
val availability: Availability

Team availability.

Link copied to clipboard
val config: SiteConfig

Site settings.

Link copied to clipboard
val conversation: ConversationSummary? = null

The active conversation, if any.

Link copied to clipboard
val protocolVersion: Int = 1

Protocol version the gateway speaks.

Link copied to clipboard
val timeline: List<TimelineItem>

The last messages of the active conversation, oldest first.

Link copied to clipboard
val timelineHasMore: Boolean? = null

Older items exist before timeline; null from gateways that do not say.

Link copied to clipboard
val visitor: VisitorDto

The visitor.

Link copied to clipboard
val visitorToken: String

The visitor token to keep and send on every call.

Link copied to clipboard
val wsUrl: String

Socket URL (query already carries site, app and install).