BlueConicClient class

BlueConic Flutter SDK main class providing access to BlueConic functionality.

This class provides static methods to interact with the BlueConic platform, including profile management, event tracking, consent handling, and more.

Constructors

BlueConicClient()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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

Static Methods

addConsentedObjective(String objectiveId) → Future

Adds an objective to the consented objectives list asynchronously.

addProfileValue(String property, String value) → Future

Adds a single value to the specified profile property asynchronously.

addProfileValues(String property, List<String> values) → Future

Adds multiple values to the specified profile property asynchronously.

addRefusedObjective(String objectiveId) → Future

Adds an objective to the refused objectives list asynchronously.

createClickEvent(String interactionId, Map<String, dynamic> properties) → Future

Creates a click event for user interaction tracking asynchronously.

createConversionEvent(String interactionId, Map<String, dynamic> properties) → Future

Creates a conversion event for goal tracking asynchronously.

createEvent(String name, Map<String, String> properties) → Future

Creates a custom event with the specified name and properties asynchronously.

createPageViewEvent(String screenName, Map<String, dynamic> properties) → Future

Creates a page view event for screen tracking asynchronously.

createProfile() → Future

Creates a new BlueConic profile asynchronously.

createRecommendationEvent(String storeId, String action, List<String> itemIds) → Future

Registers a recommendation event for the given store ID, action and item IDs.

createTimelineEvent(String type, DateTime date, Map<String, dynamic> properties) → Future

Creates a timeline event with a specific date and type asynchronously.

createTimelineEventById(String id, String type, DateTime date, Map<String, dynamic> properties) → Future

Creates a timeline event with a specific ID, date, and type asynchronously.

createViewEvent(String interactionId, Map<String, dynamic> properties) → Future

Creates a view event for interaction tracking asynchronously.

deleteProfile() → Future

Deletes the current profile from BlueConic servers asynchronously.

getAllProfileProperties() → Future<Map<String, List<String>>>

Retrieves all profile properties and their values asynchronously.

getConsentedObjectives() → Future<List<String>?>

Gets the list of consented objectives asynchronously.

getPrivacyLegislation() → Future<String>

Gets the current privacy legislation setting asynchronously.

getProfileId() → Future<String>

Gets the ID of the BlueConic profile asynchronously.

getProfileValue(String property) → Future<String>

Gets the value of a specified profile property asynchronously.

getProfileValues(String property) → Future<List<String>?>

Gets all values of a specified profile property asynchronously.

getRefusedObjectives() → Future<List<String>?>

Gets the list of refused objectives asynchronously.

getScreenName() → Future<String>

Gets the current screen name asynchronously.

getSegments() → Future<List<BlueConicSegment>>

Gets the segments that the profile belongs to asynchronously.

hasSegment(String segmentId) → Future<bool>

Checks whether the BlueConic profile belongs to a specific segment asynchronously.

incrementProfileValue(String property, int value) → Future

Increments a numeric profile property value asynchronously.

initialize(BlueConicConfiguration configuration) → Future<bool>

Initializes the BlueConic SDK with the provided configuration asynchronously.

isEnabled() → Future<bool>

Checks whether the BlueConic client is currently enabled asynchronously.

publishAdvancedEvent(String name, List<String> values) → Future

Publishes an advanced event with custom name and context values asynchronously.

publishClickEvent(String selector, List<String> values) → Future

Publishes a click event for the given selector and context values asynchronously.

publishFormSubmitEvent(String selector, List<String> values) → Future

Publishes a form submit event for the given selector and context values asynchronously.

publishUpdateContentEvent(String selector, String value) → Future

Publishes an update content event for the given selector and value asynchronously.

publishUpdateValuesEvent(String selector, String value) → Future

Publishes an update values event for the given selector and value asynchronously.

setConsentedObjectives(List<String> objectiveIds) → Future

Sets the complete list of consented objectives asynchronously.

setEnabled(bool isEnabled) → Future

Enables or disables the BlueConic client asynchronously.

setLocale(String locale) → Future

Sets the locale for BlueConic parameters and content asynchronously.

setPrivacyLegislation(String legislation) → Future

Sets the privacy legislation for the current profile asynchronously.

setProfileValue(String property, String value) → Future

Sets a single value for the specified profile property asynchronously.

setProfileValues(String property, List<String> values) → Future

Sets multiple values for the specified profile property asynchronously.

setRefusedObjectives(List<String> objectiveIds) → Future

Sets the complete list of refused objectives asynchronously.

subscribe(String identifier, String eventName, {bool onlyOnce = false}) → Stream

Subscribes to BlueConic events with a specific identifier and event name.

unsubscribe(String identifier) → Future<void>

Unsubscribes from BlueConic events using the subscription identifier.

updateProfile() → Future

Synchronizes the BlueConic profile with the server asynchronously.