chat/dev.hatang.chat/HatangChat

HatangChat

Entry point of the Hatang chat SDK. Call configure once (in Application.onCreate), then open the chat, identify the user and observe state / unreadCount / events.

HatangChat.configure(this, HatangConfig(siteId = "site_…", appKey = "hak_…"))
HatangChat.open(context)

Properties

config

val config: HatangConfig

The configuration given to configure; throws when it has not run.

DEFAULT_BASE_URL

const val DEFAULT_BASE_URL: String

The production gateway.

engine

val engine: ChatEngine

The state machine (advanced hosts); throws when configure has not run.

events

val events: Flow<HatangEvent>

Host-facing events: ready, opened, closed, messages, status, conversions, session changes, outdated.

isConfigured

val isConfigured: Boolean

configure has run.

isOpen

val isOpen: Boolean

A chat screen is on screen.

session

val session: HatangSession

The current session (visitor, conversation, locale).

state

val state: StateFlow<ChatState>

Every snapshot the chat UI renders (an idle state before configure). Follows re-configuration.

unreadCount

val unreadCount: StateFlow<Int>

Messages received while the chat was not on screen (for badges).

Functions

clearPushToken

suspend fun clearPushToken()

Unregisters the push token (sign-out).

fun close()

Closes every chat screen opened by open, openInbox or handleNotification.

configure

fun configure(context: Context, config: HatangConfig)

Configures the SDK. Calling it again replaces the previous instance (the old engine is disposed). With HatangConfig.autoConnect the SDK bootstraps and connects in the background right away.

connect

suspend fun connect()

Bootstraps and connects (after autoConnect = false or disconnect).

conversationIdOf

fun conversationIdOf(data: Map<String, String>): String?

The conversation a Hatang notification points at, if any.

disconnect

suspend fun disconnect()

Closes the socket; the SDK stays configured.

dispose

fun dispose()

Releases the engine and every resource; configure again to use the SDK afterwards.

handleNotification

fun handleNotification(context: Context, data: Map<String, String>): Boolean

Opens the conversation a Hatang notification points at (from the notification's tap, e.g. the launcher activity's intent extras). Returns false for foreign payloads. Starts the engine when it is not running yet (cold start).

identify

suspend fun identify(user: HatangUser)

Attaches the host user's identity. Pass a hash (HMAC-SHA256 of the user id with the site's identity secret, computed on your server) for verified identities. Throws HatangException on failure.

isHatangNotification

fun isHatangNotification(data: Map<String, String>): Boolean

true when an FCM data payload came from Hatang (hatang: "1").

linkTokenFromUri

fun linkTokenFromUri(uri: Uri): String?

The restore token inside a magic link: /c/<token> paths or a hatang_restore query parameter; null otherwise.

open

fun open(context: Context, conversationId: String? = null)

Opens the chat screen in its own activity (the active conversation, or conversationId).

openInbox

fun openInbox(context: Context)

Opens the visitor's conversation list.

openIntent

fun openIntent(context: Context, conversationId: String? = null): Intent

An intent that opens the chat (for a notification's PendingIntent).

purchaseToken

fun purchaseToken(userId: String): String

The account id for one of your users: pass it as setObfuscatedAccountId when launching the Play billing flow so Google Play's notifications reach this customer in Hatang.

pushEvent

fun pushEvent(name: String, data: Map<String, Any?>? = null)

Records a custom event on the active conversation.

reportPurchase

suspend fun reportPurchase(storeProductId: String, purchaseToken: String? = null, amount: Double? = null, currency: String? = null, productType: String = "subs", consumable: Boolean? = null): Boolean

After a successful in-app purchase. With the Play purchaseToken Hatang verifies it with Google, records it for this person and acknowledges it (Play refunds unacknowledged purchases after three days). productType is "subs" or "inapp"; consumable marks one-time products used up in the app. The team also gets an internal note.

reset

suspend fun reset()

Forgets this visitor (sign-out): fresh visitor, old token revoked.

restoreSession

suspend fun restoreSession(linkToken: String)

Restores the session behind a "we replied" magic-link token (see linkTokenFromUri).

setData

suspend fun setData(data: Map<String, Any?>)

Attaches custom attributes shown to agents.

setLocale

suspend fun setLocale(locale: HatangLocale)

Switches the language.

setPushToken

suspend fun setPushToken(token: String)

Registers the FCM token for this visitor. Safe before the SDK is ready: registration is deferred and repeated when the visitor or app version changes. Call it from FirebaseMessagingService.onNewToken and once at start-up with FirebaseMessaging.getInstance().token.

setScreen

fun setScreen(name: String, params: Map<String, String>? = null)

Reports the screen the app shows (Live board and page views).

showMessage

fun showMessage(text: String, senderName: String? = null)

Shows a local-only assistant bubble (never sent to the gateway).