Ha Tang Chat for Android

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

VisitorDto

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

data class VisitorDto(val id: String = "", val siteId: String = "", val email: String? = null, val name: String? = null, val phone: String? = null, val avatarUrl: String? = null, val externalId: String? = null, val customData: JsonObject = EmptyJsonObject, val locale: HatangLocale? = null, val identifiedAt: Instant? = null, val client: String = "app", val app: VisitorAppInfo? = null, val currentScreen: String? = null, val visits: Int = 1, val raw: JsonObject = EmptyJsonObject)

The visitor (this app's user as the site sees them).

Constructors

constructor(id: String = "", siteId: String = "", email: String? = null, name: String? = null, phone: String? = null, avatarUrl: String? = null, externalId: String? = null, customData: JsonObject = EmptyJsonObject, locale: HatangLocale? = null, identifiedAt: Instant? = null, client: String = "app", app: VisitorAppInfo? = null, currentScreen: String? = null, visits: Int = 1, raw: JsonObject = EmptyJsonObject)

Types

object Companion

Properties

val app: VisitorAppInfo? = null

Registered app details for app visitors.

@SerialName(value = "avatar_url")

val avatarUrl: String? = null

Avatar URL.

val client: String

web or app.

@SerialName(value = "current_screen")

val currentScreen: String? = null

The screen the app reported.

@Serializable(with = LenientObjectSerializer::class)

@SerialName(value = "custom_data")

val customData: JsonObject

Custom data (from identify / setData).

val email: String? = null

Known email.

@SerialName(value = "external_id")

val externalId: String? = null

The host app's user id (from identify).

Visitor id.

@Serializable(with = InstantOrNullSerializer::class)

@SerialName(value = "identified_at")

val identifiedAt: Instant? = null

When the visitor was identified.

val isIdentified: Boolean

Identified via identify (has an external id, email or phone).

@Serializable(with = HatangLocaleOrNullSerializer::class)

val locale: HatangLocale? = null

Preferred locale.

val name: String? = null

Known name.

val phone: String? = null

Known phone.

@Transient

val raw: JsonObject

The full wire payload.

@SerialName(value = "site_id")

val siteId: String

Site id.

val visits: Int = 1

Number of visits.

Functions

fun toJson(): JsonObject

The wire shape (unknown fields from raw kept).