ColadaConfig class

Configuration passed once to Colada.initialize.

Only publicTenantKey is required. Everything else has a sensible default, and most integrations will never set the others.

await Colada.initialize(
  ColadaConfig(
    publicTenantKey: const String.fromEnvironment('COLADA_TENANT_KEY'),
    strictMode: kDebugMode,
  ),
);

Annotations

• @immutable

Constructors

ColadaConfig({required String publicTenantKey, bool debug = false, bool strictMode = false, String? existingDeviceId, bool automaticDeepLinkForwarding = true})

Creates a configuration.

const

Properties

automaticDeepLinkForwarding → bool

Whether the SDK forwards incoming deep links to Colada by itself.

final

debug → bool

Enables verbose logging on Colada.logs.

final

existingDeviceId → String?

Migration only. An existing stable device identifier to adopt.

final

hashCode → int

The hash code for this object.

no setter, override

publicTenantKey → String

Your app's public API key, issued by Colada.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

strictMode → bool

Turns silent degradation into loud failure.

final

Methods

copyWith({String? publicTenantKey, bool? debug, bool? strictMode, String? existingDeviceId, bool? automaticDeepLinkForwarding}) → ColadaConfig

Returns a copy with the given fields replaced.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

Never prints the tenant key in full — see redactKey.

override

validate() → void

Throws ColadaInvalidConfigException if this configuration cannot be used.

Operators

operator ==(Object other) → bool

The equality operator.

override

Static Methods

redactKey(String key) → String

Masks a tenant key for logging, e.g. pk_live_a1b2….

Constants

tenantKeyHexLength → const int

Number of hexadecimal characters that must follow tenantKeyPrefix.

tenantKeyPrefix → const String

Required prefix of a valid publicTenantKey.