A structure that contains configuration details for the connected customer device.
This is available on the ``Event/ready`` event after the merchant
device establishes the peer connection with the customer's device.
Members (4)
get · iOS 27.0+
clientType
TypeScript
get clientType(): CustomerEngagementSession_PeerClientType
Swift declaration
let clientType: CustomerEngagementSession.PeerClientType
An enum value that indicates the type of connected peer client.
Only certain request types are available if the peer client is the `web` type.
get · iOS 27.0+
sessionToken
TypeScript
get sessionToken(): (CustomerEngagementSession_Token) | null
Swift declaration
let sessionToken: CustomerEngagementSession.Token?
The session token from the customer's device.
get · iOS 27.0+
locale
TypeScript
get locale(): _Foundation_Locale
Swift declaration
let locale: Locale
The customer's current locale.
Localize all merchant-supplied text to the customer's locale.
get · iOS 27.0+
version
TypeScript
get version(): string
Swift declaration
let version: String
The engagement schema version of the connected customer device.