bloombox / bloombox.client.services.telemetry / TelemetryClient / EventContext

EventContext

data class EventContext (source)

Context for an event, with the opportunity to override settings and configuration for the telemetry client. This is different from other API clients and services, in that it offers many more settings than usual - these values (i.e. the 'userKey', 'deviceUUID', and so on) are automatically attached as "event context" to events sent with the resulting client object.

Constructors

<init>

EventContext(partner: String? = null, location: String? = null, deviceUUID: String? = null, userKey: String? = null, orderKey: String? = null, section: Section? = null, item: ProductKey? = null, fingerprint: String? = null, group: String? = null, nativeContext: NativeDeviceContext? = null, browserContext: BrowserDeviceContext? = null)

Properties

browserContext	`val browserContext: BrowserDeviceContext?` Browser context to send for an event. In circumstances where an event is relayed or originally sent from an internet-facing browser agent, this context structure specifies items like the browser name, version, pixel density, capabilities, and vendor.
deviceUUID	`val deviceUUID: String?` Device UUID to report. Requires a value for `partner` and `location`. Used to signify events sent from a specific, known, partner-co-located device.
fingerprint	`val fingerprint: String?` Unique fingerprint for an anonymous device. This is generated client-side and not guaranteed to be unique globally - only in the scope of a single partner/location account. Usually a hashed UUID is used for this value so as to guarantee a reasonable level of collision resistance.
group	`val group: String?` Group or session ID for an event. Generated upon initialization of a new session, which happens client-side, without consulting the server. Basically, it can be specified as any string to correlate events of a single "session." It is usually implemented as a hashed UUID to guarantee a reasonable level of collision resistance.
item	`val item: ProductKey?` Item key to report as active for this event. In cases where an event is a commercial-style occurrence (i.e. an impression, view, or action on a section or product), this product key is included as context, where applicable.
location	`val location: String?` Location code for an event. Explicitly overrides `defaultLocation`. Specifies the partner's location record scope for a given RPC transaction.
nativeContext	`val nativeContext: NativeDeviceContext?` Native device context to use for an event. This specifies information about the native hardware on which the reported event occurred. Native device context includes things like device screen resolution, window size, OS name and version, the active telemetry client library language and version, and so on.
orderKey	`val orderKey: String?` Order key to report as active for this event. In general, this ID may not exist - it is sent with any and all events by the client and can be generated client-side, without consulting the server. A conversion is recorded when the order itself is submitted.
partner	`val partner: String?` Partner code for an event. Explicitly overrides `defaultPartner`. Specifies the partner account scope for a given RPC transaction.
section	`val section: Section?` Menu section to report as active for this event. In cases where an event is a commercial-style occurrence (i.e. an impression, view, or action on a section or product), this section key is included as context. All commercial events with a product scope have a section scope, too.
userKey	`val userKey: String?` Active user account key, if applicable. In scenarios where an end-user logs in, their key is set as soon as their account is validated or otherwise resolved.