index library

Classes

ApiQuerySorting: The ApiQuerySorting class represents a sorting query for an API with a specified property and order.
AppearedInLocationEvent: The AppearedInLocationEvent class represents an event where a client has appeared in a specific location, with latitude and longitude parameters.
AppearedInLocationEventParameters: The class defines two constant strings representing latitude and longitude parameters for an event.
AssignVoucherData: The AssignVoucherData class represents data related to a voucher, including its code, expiration date, redemption date, and creation/update timestamps.
AssignVoucherResponse: The AssignVoucherResponse class represents a response object with a message and optional data, which can be initialized from a map.
BaseApiQuery: The class represents a base API query with properties for limit, page, sorting, and includeMeta.
BaseSettings
CartEvent: The class CartEvent defines a custom event with parameters for a shopping cart action.
CartEventParameters: The class defines constant strings for various parameters used in a cart event.
ClientAccountInformation: The class represents client account information with various properties such as email, phone, name, address, and agreements.
ClientAccountRegisterContext: The ClientAccountRegisterContext class represents the context for registering a client account, including personal information, agreements, and attributes.
ClientAccountUpdateContext: The ClientAccountUpdateContext class represents the context for updating a client's account information, including personal details, agreements, and custom attributes.
ClientAgreements: The ClientAgreements class represents a client's agreements for email, SMS, push notifications, Bluetooth, RFID, and Wi-Fi, and includes methods for setting and getting these agreements, as well as a constructor for creating objects from a Map.
ClientAuthContext: The ClientAuthContext class represents the authentication context of a client, including their ID, agreements, and attributes.
ClientConditionalAuthResult: The class ClientConditionalAuthResult represents the result of a conditional authentication process, including the status and conditions.
ClientCondtitionalAuthContext: The ClientCondtitionalAuthContext class represents the authentication context of a client, including their ID, agreements, and attributes.
ClientImpl
ClientSimpleAuthenticationData: The ClientSimpleAuthenticationData class is a data model that represents the simple authentication data of a client. It contains various properties such as email, phone number, custom ID, UUID, first name, last name, display name, sex, birth date, avatar URL, company, address, city, province, zip code, country code, agreements, and attributes.
ContentImpl
CustomEvent: The CustomEvent class extends the Event class and defines a custom event type with a label, action, and parameters.
Dependencies: The class Dependencies contains two static constants representing MethodChannels for the Synerise Flutter SDK and its background operations.
Document: The Document class represents a document with an identifier, slug, schema, and optional content stored as a map.
Event: The class "Event" defines a custom event with a type, label, action, and parameters, and provides a method to convert it to a map.
GeneralSettings
HitTimerEvent: The HitTimerEvent class is an event that represents a hit timer event with a label and optional parameters.
InAppMessageData: The InAppMessageData class represents data for an in-app message campaign, including campaign hash, variant identifier, additional parameters, and a flag for testing.
InAppMessagingSettings
InjectorBannerListener
InjectorImpl
InjectorInAppMessageListener
InjectorListener
InjectorSettings
InjectorWalkthroughListener
LoggedInEvent: The class represents an event of signing in user with a label, event type, and optional parameters.
LoggedOutEvent: The LoggedOutEvent class represents an event of signing out of a client with a label and optional parameters.
NotificationsImpl
NotificationsListener
NotificationsSettings
ProductAddedToCartEvent: The class represents an event of adding a product to a cart with relevant information.
ProductAddedToFavoritesEvent: ProductAddedToFavoritesEvent represents an event of adding a product to favorites with a label and optional parameters.
ProductRemovedFromCartEvent: The ProductRemovedFromCartEvent class represents an event where a product is removed from the cart.
ProductViewedEvent: The ProductViewedEvent class represents an event where a product has been viewed, with specific parameters such as the product ID and name.
ProductViewedEventParameters: The class defines constant strings for the parameters of a product viewed event.
Promotion: The Promotion class represents a promotional offer with various properties such as discount type, redemption limits, and expiration dates.
PromotionDetails: The PromotionDetails class represents details of a promotion, including the discount type, and provides methods for converting to and from a Map.
PromotionDiscountModeDetails: The class PromotionDiscountModeDetails contains information about the discount steps and usage trigger for a promotion.
PromotionDiscountStep: The PromotionDiscountStep class represents a step in a promotion that includes a discount value and a usage threshold.
PromotionDiscountTypeDetails: The PromotionDiscountTypeDetails class represents details about a promotion discount type and includes methods for creating an instance from a Map and converting it to a Map.
PromotionIdentifier: The PromotionIdentifier class represents a key-value pair object used to identify a promotion, with methods for converting to and from a map.
PromotionResponse: The code defines a Dart class for a promotion response and includes a private constructor and a function to convert a list of objects to a list of promotions.
PromotionsApiQuery: The PromotionsApiQuery class is a subclass of BaseApiQuery that allows for filtering promotions by status and type.
PromotionsImpl
PromotionSortingKey
PushCancelledEvent: The PushCancelledEvent class is a custom event that represents the cancellation of a push notification.
PushClickedEvent: The PushClickedEvent class is a custom event that represents a push notification click with a label and optional parameters.
PushViewedEvent: The PushViewedEvent class is a custom event that represents a push notification being viewed, with a label and optional parameters.
Recommendation: The class Recommendation represents a recommendation with attributes and an item ID, and can be converted to and from a map.
RecommendationClickEvent: The class represents a recommendation click event with specific parameters.
RecommendationClickEventParameters: The class defines static constants for parameters used in a recommendation click event.
RecommendationEvent: The class RecommendationEvent extends CustomEvent and creates a new event for recommendations with a label, action, and parameters.
RecommendationOptions: The class "RecommendationOptions" contains various properties for configuring recommendations, such as product IDs, filters, and display attributes.
RecommendationResponse: The code defines a Dart class for a recommendation response and includes a function to convert a list of objects to a list of recommendations.
RecommendationSeenEvent: This is a recommendation seen event with parameters such as product ID, product name, campaign ID, and campaign hash.
RecommendationSeenEventParameters: The class defines static constants for parameters related to a recommendation seen event.
RecommendationViewEvent: The class RecommendationViewEvent is used to create an event with specific parameters for tracking recommendation views.
RecommendationViewParameters: The class defines static constants for parameters used in recommendation views.
RegisteredEvent: The RegisteredEvent is an event of client registration with a label, parameters, and a specific type of 'client.register'.
ScreenView: The ScreenView class represents a screen view with various properties such as identifier, name, hashString, path, priority, audience information, data, createdAt and updatedAt timestamps.
ScreenViewAudienceInfo: The ScreenViewAudienceInfo class represents information about the audience of a screen view, including segments, query, and target type.
SearchedEvent: The SearchedEvent class is a custom event that represents a search action with a label and optional parameters.
SettingsImpl
SettingsKeys
SharedEvent: The SharedEvent represents a shared event with a label and optional parameters.
SyneriseInitializer
Token: The Token class represents a token with a string value, origin information, and an expiration date.
TrackerImpl
TrackerSettings
UnitPrice: The UnitPrice class represents a unit price with an amount and currency, and has a method to convert it to a map.
VisitedScreenEvent: The VisitedScreenEvent class is an event that represents a screen view with a label and optional parameters.
VoucherCodesData: The VoucherCodesData class represents voucher codes data and includes a constructor that takes a Map as an argument to create a new instance of the class.
VoucherCodesResponse: The above code defines a Dart class and a private function to convert a list of data objects to a list of voucher codes data objects.

Enums

ApiQuerySortingOrder: This is an enumeration in Dart that defines two values: ascending and descending. Each value has a corresponding apiQuerySortingOrder string value ('asc' for ascending and 'desc' for descending).
ClientConditionalAuthStatus: ClientConditionalAuthStatus represents the status of conditional client process. Each enum value represents a different status and is associated with a string value.
ClientSex: This is defining an enumeration type called ClientSex with four possible values: notSpecified, male, female, and other. Each value is assigned a string representation that corresponds to the value's name in all caps.
ClientSignOutMode: ClientSignOutMode represents the mode that is used to sign out a client, and has two values: signOut and signOutWithSessionDestroy.
IdentityProvider: An enumeration called IdentityProvider with six possible values: SYNERISE, FACEBOOK, GOOGLE, OAUTH, APPLE, and UNKNOWN.
PromotionDiscountMode: This is defining an enumeration called PromotionDiscountMode with two possible values: staticMode and stepMode. Each value is associated with a string value ('STATIC' and 'STEP', respectively). The getPromotionDiscountModeFromString method is used to convert a string value to the corresponding enum value.
PromotionDiscountType: This is defining an enumeration type called PromotionDiscountType with seven possible values: none, percent, amount, twoForOne, points, multibuy, and exactPrice. Each value is associated with a string literal that represents the value in a human-readable format. The getPromotionDiscountTypeFromString method is used to convert a string to the corresponding PromotionDiscountType value.
PromotionDiscountUsageTrigger: This is defining an enum called PromotionDiscountUsageTrigger with two possible values: transaction and redeem. Each value is associated with a string value ('TRANSACTION' and 'REDEEM' respectively). The enum also has a constructor that takes a string parameter and a method getPromotionDiscountUsageTriggerFromString that returns the corresponding enum value based on a given string input. There is also a method promotionDiscountUsageTriggerAsString that returns the string value associated with the enum value.
PromotionIdentifierKey: This is defining an enumeration called PromotionIdentifierKey with two possible values: uuid and code. Each value is associated with a string value ('UUID' and 'CODE' respectively). The const PromotionIdentifierKey(this.promotionIdentifierKey) constructor is used to initialize the promotionIdentifierKey field with the string value associated with each enumeration value.
PromotionItemScope: This code is defining an enumeration type called PromotionItemScope with two possible values: lineItem and basket. Each value is associated with a string value ('LINE_ITEM' and 'BASKET', respectively) that represents the promotion item scope.
PromotionStatus: This is defining an enumeration called PromotionStatus with four possible values: none, active, assigned, and redeemed. Each value is associated with a string representation ('NONE', 'ACTIVE', 'ASSIGNED', and 'REDEEMED', respectively).
PromotionType: This is an enum called PromotionType that defines five possible values: unknown, membersOnly, custom, general, and handbill. Each value is associated with a string representation. The enum also has a constructor that takes a string argument and a method getPromotionTypeFromString that returns a PromotionType value based on a given string input. If the input string matches one of the defined enum values, then the corresponding enum value is returned. Otherwise, the value unknown is returned. The enum also has a method promotionTypeAsString that returns the string representation of the enum value.
RecommendationFiltersJoinerRule: The enum RecommendationFiltersJoinerRule is defining a set of possible values for a recommendation filter joiner rule. It has three possible values: and, or, and replace.
SyneriseSource: SyneriseSourcerepresents the possible source of Synerise activities. It has several possible values such as 'SIMPLE_PUSH', 'BANNER', 'WALKTHROUGH', etc.
TokenOrigin: TokenOriginrepresents the possible origins of a token. It has several possible values such as 'SYNERISE', 'FACEBOOK', 'GOOGLE', etc.
VoucherCodeStatus: This is defining an enumeration type called VoucherCodeStatus with four possible values: unassigned, assigned, redeemed, and canceled. Each value is associated with a string representation ('UNASSIGNED', 'ASSIGNED', 'REDEEMED', and 'CANCELED', respectively).

Properties

settingsValues ↔ Map: getter/setter pair
syneriseInitialized ↔ bool: getter/setter pair

Typedefs

GetFunction = dynamic Function<T>(String key, [bool isSupportedPlatform, dynamic androidDefault, dynamic iosDefault])
InjectorBannerListenerFunction = void Function(InjectorBannerListener listener)
InjectorInAppMessageListenerFunction = void Function(InjectorInAppMessageListener listener)
InjectorListenerFunction = void Function(InjectorListener listener)
InjectorWalkthroughListenerFunction = void Function(InjectorWalkthroughListener listener)
NotificationsListenerFunction = void Function(NotificationsListener listener)
SetFunction = dynamic Function<T>(String key, dynamic value, [bool isSupportedPlatform])

main/index library

Classes

Enums

Properties

Typedefs

synerise_flutter_sdk package