KnotConfiguration class
Represents the configuration settings for the Knot SDK.
Constructors
-
KnotConfiguration({required String sessionId, required String clientId, required Environment environment, Product? product, List<
int> ? merchantIds, List<String> ? domainUrls, bool? useCategories, String? entryPoint, bool? useSearch, CustomerConfiguration? customerConfiguration, String? locale, Map<String, String> ? metadata}) - Constructs a KnotConfiguration with required and optional parameters.
Properties
- clientId → String
-
The client identifier.
final
- customerConfiguration → CustomerConfiguration?
-
The customer configuration for the session.
final
-
domainUrls
→ List<
String> ? -
A list of allowed domain URLs for the session.
final
- entryPoint → String?
-
The entry point for the session.
final
- environment → Environment
-
The environment in which the SDK is operating.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- locale → String?
-
The locale for language localization (BCP-47 format, e.g., "en-US", "es-US").
If not provided, defaults to "en-US".
final
-
merchantIds
→ List<
int> ? -
A list of merchant IDs associated with the configuration.
final
-
metadata
→ Map<
String, String> ? -
Optional metadata to be included in webhook payloads.
Keys and values must be strings. Maximum 10 keys, 500 chars per value.
final
- product → Product?
-
The product type used in the SDK.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sessionId → String
-
The unique session identifier.
final
- useCategories → bool?
-
Whether category-based filtering is enabled.
final
- useSearch → bool?
-
Whether search functionality is enabled.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> - Converts the KnotConfiguration object to a JSON-compatible map.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited