RudderOption class
A class for managing event-level options in RudderStack events.
RudderOption provides functionality to configure per-event settings including external IDs, integration-specific configurations, and custom contexts. These options can be passed with individual track, identify, page, and screen calls.
Key features:
- External IDs: Link events to external systems like CRM or marketing tools
- Integrations: Control which destinations receive specific events
- Custom Contexts: Add additional contextual information to events
Constructors
Properties
-
customContexts
↔ Map<
String, Map< ?String, Object> > -
Map of custom contexts to add additional event data.
getter/setter pair
-
externalIds
↔ List<
Map< ?String, String> > -
List of external ID mappings for linking events to external systems.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
-
integrations
↔ Map<
String, Object> ? -
Map of integration configurations to control event delivery.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
getMobileIntegrationsMap(
) → Map< String, bool> ? - Gets the integrations map formatted for mobile platforms.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
putCustomContext(
String key, Map< String, Object> value) → RudderOption - Adds custom context information to the event.
-
putExternalId(
String type, String id) → RudderOption - Adds or updates an external ID for linking this event to external systems.
-
putIntegration(
String type, Object enabled) → RudderOption - Configures whether a specific integration should receive this event.
-
putIntegrationWithFactory(
RudderIntegration factory, Object enabled) → RudderOption - Configures an integration using its factory instance.
-
toMobileMap(
) → Map< String, Object> - Converts the options to a format suitable for mobile platforms.
-
toString(
) → String -
A string representation of this object.
override
-
toWebMap(
) → Map< String, Object> - Converts the options to a format suitable for web platforms.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited