CrossmintClientConfig class final

Configuration for CrossmintClient.

Extends CrossmintApiConfig (the shared base shape used across all Crossmint SDK platforms) with the Flutter-specific plug-points authStorage, logger, refreshRoute, and logoutRoute.

const config = CrossmintClientConfig(
  apiKey: 'YOUR_STAGING_API_KEY',
  appScheme: 'com.your.app',
);

Use a client key (ck_*) for frontend apps — they require origin for auth. Use a server key (sk_*) only in server contexts; it needs no origin.

Inheritance

Constructors

CrossmintClientConfig({required String apiKey, String? appId, String? appScheme, String? origin, Uri? overrideBaseUrl, String? extensionId, CrossmintAuthStorage? authStorage, CrossmintLogger? logger, Uri? refreshRoute, Uri? logoutRoute})
Creates a CrossmintClientConfig.
const

Properties

apiKey → String
Crossmint API key.
finalinherited
appId → String?
Application identifier registered with Crossmint — usually matches the mobile bundle ID (iOS) or package name (Android). If omitted, the SDK auto-resolves it from platform metadata during initialize().
finalinherited
appScheme → String?
Deep-link scheme the Crossmint auth page redirects back to after sign-in. Typically equals appId on mobile. Required for OAuth flows.
finalinherited
authStorage → CrossmintAuthStorage?
Custom session / token store. When null, the SDK uses FlutterSecureStorage under the hood.
final
extensionId → String?
Browser-extension identifier used by extension-embedded flows.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
logger → CrossmintLogger?
Custom logger sink. When null, the SDK uses a no-op logger in release and a debugPrint-backed logger in debug.
final
logoutRoute → Uri?
Optional custom server endpoint for logout.
final
origin → String?
Origin header sent with requests when using a client key. Required on web; optional on mobile (the SDK derives it from appId when omitted).
finalinherited
overrideBaseUrl → Uri?
Overrides the default Crossmint API base URL — used for local development or pointing at a custom-hosted environment.
finalinherited
refreshRoute → Uri?
Optional custom server endpoint for token refresh.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited