customer-android-kotlin

//core/com.kustomer.core.models.handoff/HandoffParameters

HandoffParameters

@JsonClass(generateAdapter = true)

data class HandoffParameters(@Json(name = "active")val active: Boolean, @Json(name = "from")val from: String, @Json(name = "messages")val messages: List<HandoffMessage>, @Json(name = "brand")val brand: String? = null, @Json(name = "externalId")val externalId: String? = null, @Json(name = "lang")val lang: String? = null, @Json(name = "subStatus")val subStatus: String? = null, @Json(name = "trackingId")val trackingId: String? = null)

Parameters for creating a handoff conversation.

Parameters

androidJvm

   
active Whether the session should be created open (true) or closed (false)
from Sender identifier for outbound messages (e.g., user ID, agent name, or system identifier)
messages Array of handoff messages (must contain at least 2 messages: one inbound and one outbound)
brand Optional brand ID to associate with the session
externalId Optional external identifier to associate with the session
lang Optional language code (e.g., ‘en’, ‘es’, ‘fr’) applied to all messages
subStatus Optional valid MongoDB ObjectId of a conversation substatus. Treated as open or done per active: active true = open substatus, active false = done substatus.
trackingId Optional tracking identity ObjectId for the session; omit to use the token default on the server

Constructors

   
HandoffParameters [androidJvm]
constructor(@Json(name = "active")active: Boolean, @Json(name = "from")from: String, @Json(name = "messages")messages: List<HandoffMessage>, @Json(name = "brand")brand: String? = null, @Json(name = "externalId")externalId: String? = null, @Json(name = "lang")lang: String? = null, @Json(name = "subStatus")subStatus: String? = null, @Json(name = "trackingId")trackingId: String? = null)

Properties

Name Summary
active [androidJvm]
val active: Boolean
brand [androidJvm]
val brand: String? = null
externalId [androidJvm]
val externalId: String? = null
from [androidJvm]
val from: String
lang [androidJvm]
val lang: String? = null
messages [androidJvm]
val messages: List<HandoffMessage>
subStatus [androidJvm]
val subStatus: String? = null
trackingId [androidJvm]
val trackingId: String? = null