Builder

class Builder

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard

This should be stable, secure, unique to your product.

Link copied to clipboard

The metadata schema version. Usually constructed as the major plus minor version part without dots. E.g., for both 2061.1 and 2026.1.1 it would be 261. Use 0 for unversioned metadata.

Link copied to clipboard

true by default to optimize logging. Set to false for test cases that require synchronous logging.

Link copied to clipboard

If false, events are discarded when queued. Default is true, but for production you should use a (potentially dynamic) variable reflecting user consent.

Link copied to clipboard

If false, events can go through validation and anonymization but are discarded after. Default is true, but for production you should use a (potentially dynamic) variable reflecting user consent.

Link copied to clipboard

If false, the queue is never drained. Should only be true if user consent is given. Default is true, but for production you should use a (potentially dynamic) variable reflecting user consent.

Link copied to clipboard

If set to true, the SDK uses the test config rather than the production config. The test config sends data to staging instead of to production.

Link copied to clipboard
lateinit var productCode: String

Short letter code stored as a string to identify the product. More information on YouTrack.

Link copied to clipboard
lateinit var productName: String

Human-readable name of the product.

Link copied to clipboard
lateinit var productVersion: String

Version of the product. More information on YouTrack.

Link copied to clipboard
lateinit var recorderCode: String

Short letter code stored as a string to identify the product's recorder(s). More information on YouTrack.

Link copied to clipboard
lateinit var recorderVersion: String

Version of the product's recorder(s).

Link copied to clipboard

If true, metadata is fetched upon startup; otherwise, after 3 minutes. Immediate fetching can impact the startup time of, e.g., IDEs but can be useful for tests or lightweight applications.

Link copied to clipboard
lateinit var regionCode: RegionCode

Chooses the server for data storage, based on where that data is collected. Use RegionCode.ALL except for data collected in China, which requires RegionCode.CN to comply with Chinese restrictions.

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard