Ha Tang Chat for Android

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

SiteConfig

@Serializable(with = SiteConfig.Serializer::class)

data class SiteConfig(val siteId: String = "", val name: String = "", val color: String = "#0ea5e9", val position: String = "right", val localeDefault: String = "auto", val greeting: Map<String, String> = emptyMap(), val awayMessage: Map<String, String> = emptyMap(), val offlineCapture: OfflineCapture = OfflineCapture.OFF, val hideWhenOffline: Boolean = false, val theme: SiteTheme = SiteTheme.AUTO, val botEnabled: Boolean = false, val agentAvatars: List<AgentAvatar> = emptyList(), val launcher: LauncherConfig = LauncherConfig(), val header: HeaderConfig? = null, val greetingOptions: GreetingOptions? = null, val contactButtons: List<ContactButton> = emptyList(), val raw: JsonObject = EmptyJsonObject)

Site settings the widget and SDK render from.

Constructors

constructor(siteId: String = "", name: String = "", color: String = "#0ea5e9", position: String = "right", localeDefault: String = "auto", greeting: Map<String, String> = emptyMap(), awayMessage: Map<String, String> = emptyMap(), offlineCapture: OfflineCapture = OfflineCapture.OFF, hideWhenOffline: Boolean = false, theme: SiteTheme = SiteTheme.AUTO, botEnabled: Boolean = false, agentAvatars: List<AgentAvatar> = emptyList(), launcher: LauncherConfig = LauncherConfig(), header: HeaderConfig? = null, greetingOptions: GreetingOptions? = null, contactButtons: List<ContactButton> = emptyList(), raw: JsonObject = EmptyJsonObject)

Types

object Companion

Properties

@Serializable(with = AgentAvatarListSerializer::class)

@SerialName(value = "agent_avatars")

val agentAvatars: List<AgentAvatar>

Online team members for the header (and the greeting's signature).

@Serializable(with = LenientStringMapSerializer::class)

@SerialName(value = "away_message")

val awayMessage: Map<String, String>

Away message per locale, shown while nobody is online.

@SerialName(value = "bot_enabled")

val botEnabled: Boolean = false

The AI assistant answers first.

val color: String

Accent colour as #rrggbb.

@Serializable(with = ContactButtonListSerializer::class)

@SerialName(value = "contact_buttons")

val contactButtons: List<ContactButton>

Other ways to reach the shop (Zalo, Messenger, phone, email).

@Serializable(with = LenientStringMapSerializer::class)

val greeting: Map<String, String>

Greeting per locale, shown when the conversation is empty.

greetingOptions

@Serializable(with = GreetingOptionsOrNullSerializer::class)

@SerialName(value = "greeting_options")

val greetingOptions: GreetingOptions? = null

Greeting display options (older gateways: null, the greeting always shows).

@Serializable(with = HeaderConfigOrNullSerializer::class)

val header: HeaderConfig? = null

Header subtitle, logo and profile (older gateways: null, the agents' initials and no subtitle).

hideWhenOffline

@SerialName(value = "hide_when_offline")

val hideWhenOffline: Boolean = false

Hide the launcher while offline (web).

val launcher: LauncherConfig

How the launcher button looks (older gateways: the default chat bubble).

@SerialName(value = "locale_default")

val localeDefault: String

vi, en or auto.

val name: String

Site (business) name shown in the header.

@SerialName(value = "offline_capture")

val offlineCapture: OfflineCapture

Pre-chat form policy.

val position: String

Launcher position on the web (left / right).

@Transient

val raw: JsonObject

The full wire payload (campaigns, social proof, ...).

@SerialName(value = "site_id")

val siteId: String

Site id.

val theme: SiteTheme

Preferred colour scheme.

Functions

fun awayMessageFor(locale: HatangLocale): String?

Away message for locale, falling back to the other language.

fun greetingFor(locale: HatangLocale): String?

Greeting for locale, falling back to the other language.

fun toJson(): JsonObject

The wire shape (unknown fields from raw kept).