Events

Event

Class model for events.

Declared In

com.synerise.sdk.event.Event

Declaration

public abstract class Event implements Serializable

Properties

Property	Type	Optional	Default	Description
eventTime	`Date`	no	-	Event time
type	`String`	no	-	Event type
action	`String`	no	-	Event action
label	`String`	no	-	This value is currently unused
clientParams	`HashMap<String, Object>`	no	-	Profile parameters
params	`HashMap<String, Object>`	no	-	Event params

Note: All properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

This method retrieves the value of the label parameter.

public String getLabel()

This method retrieves the value of the action parameter.

public String getAction()

This method retrieves the values of the clientParams object.

public HashMap<String, Object> getClientParams()

This method retrieves the value of the eventTime parameter.

public Date getEventTime()

This method retrieves the value of the type parameter.

public String getType()

This method retrieves the values of the eventParams object.

public HashMap<String, Object> getParams()

CustomEvent

Class model for custom event.

Declared In

com.synerise.sdk.event.model.CustomEvent

Declaration

public class CustomEvent extends Event

Properties

Property	Type	Optional	Default	Description
label	`String`	no	-	This value is currently unused
action	`String`	no	-	Event action
params	`TrackerParams`	yes	-	Event tracker parameters

Initializers

The following constructors are available:

public CustomEvent(@NonNull String action, @NonNull String label)

public CustomEvent(@NonNull String action, @NonNull String label, @Nullable TrackerParams params)

public CustomEvent(@NonNull String type, @NonNull String action, @NonNull String label, @Nullable TrackerParams params)

Methods

There are no methods.

AppStartedEvent

Class model for the application started event.

Declared In

com.synerise.sdk.event.model.interaction.AppStartedEvent

Declaration

public class AppStartedEvent extends Event

Note: This event will be sent every time an application is started.

Properties

Property	Type	Optional	Default	Description
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker parameters

Parameters tracked

Parameter	Description
currentSDKVersion	Current SDK version
lastSDKVersion	Last SDK version
sdkVersionCode	Current SDK version code
applicationName	Application name
version	Application version
appVersionCode	Application version code
deviceId	Device ID. Can be null
deviceModel	Device model
deviceManufacturer	Device manufacturer
deviceResolution	Device resolution
deviceType	Device type
os	OS type
osVersion	OS version
osLanguage	System language
systemPushConsent	System push agreement
networkType	Network type
origin	Origin of SDK
networkCountry	Country of network
cellType	Cell type
cellCarrier	Cell carrier
cellCountry	Cell country
cellRoaming	Cell roaming

Initializers

The following constructors are available:

public AppStartedEvent(@NonNull String label)

public AppStartedEvent(@NonNull String label, @Nullable TrackerParams params)

Methods

There are no methods.

AutoTrackingEvent

Class model for autotracking events.

Declared In

com.synerise.sdk.event.model.interaction.AutoTrackingEvent

Declaration

public class AutoTrackingEvent extends Event

Note: This event is sent only by the Synerise SDK. Sending this event in your application on your own is not recommended.

Properties

There are no public properties.

Note: The screen.interaction and screen.view events are sent by the auto-tracking module.

Initializers

There are no public constructors.

Methods

There are no methods.

ViewedPushEvent

Class model for the push.view event.

Declared In

com.synerise.sdk.event.model.push.ViewedPushEvent

Declaration

public class ViewedPushEvent extends Event

Properties

Property	Type	Optional	Default	Description
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker parameters

Initializers

The following constructors are available:

public ViewedPushEvent(@NonNull String label)

public ViewedPushEvent(@NonNull String label, @Nullable TrackerParams params)

Methods

There are no methods.

ClickedPushEvent

Class model for the push.click event.

Declared In

com.synerise.sdk.event.model.push.ClickedPushEvent

Declaration

public class ClickedPushEvent extends Event

Properties

Property	Type	Optional	Default	Description
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker parameters

Initializers

The following constructors are available:

public ClickedPushEvent(@NonNull String label)

public ClickedPushEvent(@NonNull String label, @Nullable TrackerParams params)

Methods

There are no methods.

CancelledPushEvent

Class model for the cancel push event generated.

Declared In

com.synerise.sdk.event.model.push.CancelledPushEvent

Declaration

public class CancelledPushEvent extends Event

Properties

Property	Type	Optional	Default	Description
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker parameters

Initializers

The following constructors are available:

public CancelledPushEvent(@NonNull String label)

public CancelledPushEvent(@NonNull String label, @Nullable TrackerParams params)

Methods

There are no methods.

CartEvent

Class model for the events related to a cart.

Declared In

com.synerise.sdk.event.model.products.cart.CartEvent

Declaration

public abstract class CartEvent extends Event

Inheriting classes

AddedToCartEvent RemovedFromCartEvent

Properties

Property	Type	Optional	Default	Description
type	`String`	no	-	Event type
sku	`String`	no	-	SKU of the item
label	`String`	no	-	This value is currently unused
finalPrice	`UnitPrice`	no	-	Final price of the item
quantity	`int`	no	-	Quantity of the item
params	`TrackerParams`	yes	-	Event tracker parameters

Note: The following keys: sku, name, category, categories, offline, regularUnitPrice, discountedUnitPrice, finalUnitPrice, url, producer, quantity are reserved by Synerise for the params object.

Initializers

CartEvent(@NonNull String type, @NonNull String label, @NonNull String sku, @NonNull UnitPrice finalPrice, int quantity,
              @Nullable TrackerParams params)

Methods

This method sets a value for the name parameter.

public void setName(String name)

This method sets a value for the category parameter.

public void setCategory(String category)

This method sets values for the categories parameter.

public void setCategories(List<String> categories)

This method sets a value for the offline parameter.

public void setOffline(boolean offline)

This method sets the value of the regularPrice parameter.

public void setRegularPrice(UnitPrice regularPrice)

This method sets the value of the discountedPrice parameter.

public void setDiscountedPrice(UnitPrice discountedPrice)

This method sets the value of the url parameter.

public void setUrl(String url)

This method sets the value of the producer parameter (producer can signify a brand of the item).

public void setProducer(String producer)

AddedToCartEvent

Class model for add to cart event.

Declared In

com.synerise.sdk.event.model.products.cart.AddedToCartEvent

Declaration

public class AddedToCartEvent extends CartEvent

Properties

Property	Type	Optional	Default	Description
type	`String`	no	-	Event type
sku	`String`	no	-	SKU of the product
label	`String`	no	-	This value is currently unused
finalPrice	`UnitPrice`	no	-	Final price of the product
quantity	`int`	no	-	Quantity of the product
params	`TrackerParams`	yes	-	Event tracker params

Note: The "sku", "name", "category", "categories", "offline" , "regularUnitPrice", "discountedUnitPrice", "finalUnitPrice", "url", "producer" , "quantity" keys are reserved by Synerise in params.

Initializers

The following constructors are available:

public AddedToCartEvent(@NonNull String label, @NonNull String sku, @NonNull UnitPrice finalPrice, int quantity)

public AddedToCartEvent(@NonNull String label, @NonNull String sku, @NonNull UnitPrice finalPrice, int quantity,
                            @Nullable TrackerParams params)

Methods

This method defines the value of the name parameter.

public void setName(String name)

This method defines the value of the category parameter.

public void setCategory(String category)

This method defines the values of the categories parameter.

public void setCategories(List<String> categories)

This method defines the value of the offline parameter.

The offline parameter describes whether an event occurred outside website, for example in a cash register.

public void setOffline(boolean offline)

This method defines the value of the regularPrice parameter.

public void setRegularPrice(UnitPrice regularPrice)

This method defines the value of the discountedPrice parameter.

public void setDiscountedPrice(UnitPrice discountedPrice)

This method defines the value of the url parameter.

public void setUrl(String url)

This method defines the value of the producer parameter.

A producer is a manufacturer of the item.

public void setProducer(String producer)

RemovedFromCartEvent

Class model for remove from cart event.

Declared In

com.synerise.sdk.event.model.products.cart.RemovedFromCartEvent

Declaration

public class RemovedFromCartEvent extends CartEvent

Properties

Property	Type	Optional	Default	Description
type	`String`	no	-	Event type
sku	`String`	no	-	SKU of the product
label	`String`	no	-	This value is currently unused
finalPrice	`UnitPrice`	no	-	Final price of the product
quantity	`int`	no	-	Quantity of the product
params	`TrackerParams`	yes	-	Event tracker params

Note: The keys "sku", "name", "category", "categories", "offline" , "regularUnitPrice", "discountedUnitPrice", "finalUnitPrice", "url", "producer" , "quantity" are reserved by Synerise in params.

Initializers

The following constructors are available:

public RemovedFromCartEvent(@NonNull String label, @NonNull String sku, @NonNull UnitPrice finalPrice, int quantity)

public RemovedFromCartEvent(@NonNull String label, @NonNull String sku, @NonNull UnitPrice finalPrice, int quantity,
                            @Nullable TrackerParams params)

Methods

This method defines the value of the name parameter.

public void setName(String name)

This method defines the value of the category parameter.

public void setCategory(String category)

This method defines the values of the categories parameter.

public void setCategories(List<String> categories)

This method defines the value of the offline parameter.

The offline parameter describes whether an event occurred outside website, for example in a cash register.

public void setOffline(boolean offline)

This method defines the value of the regularPrice parameter.

public void setRegularPrice(UnitPrice regularPrice)

This method defines the value of the discountedPrice parameter.

public void setDiscountedPrice(UnitPrice discountedPrice)

This method defines the value of the url parameter.

public void setUrl(String url)

This method defines the value of the producer parameter.

A producer is a manufacturer of the item.

public void setProducer(String producer)

ProductEvent

Class model for product events.

Declared In

com.synerise.sdk.event.model.ai.ProductEvent

Declaration

public class ProductEvent extends Event

Inheriting classes

ProductViewEvent

Properties

Property	Type	Optional	Default	Description
name	`String`	no	-	Product name
type	`String`	no	-	Event type
productId	`String`	no	-	Product ID
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker params

Note: The "productId", "name", "category", "url" keys are reserved by Synerise in params.

Initializers

public ProductEvent(@NonNull String type, @NonNull String label, @NonNull String productId, @NonNull String name,
                        @Nullable TrackerParams params)

Methods

This method defines the value of the category parameter.

public void setCategory(String category)

This method defines the value of the url parameter.

public void setUrl(String url)

ProductViewEvent

Class model for the product view event.

Declared In

com.synerise.sdk.event.model.ai.ProductViewEvent

Declaration

public class ProductViewEvent extends ProductEvent

Properties

Property	Type	Optional	Default	Description
name	`String`	no	-	Product name
productId	`String`	no	-	Product ID
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker params

Note: The "productId", "name", "category", "url" keys are reserved by Synerise in params.

Initializers

The following constructors are available:

public ProductViewEvent(@NonNull String label, @NonNull String productId, @NonNull String name)

public ProductViewEvent(@NonNull String label, @NonNull String productId, @NonNull String name,
                            @Nullable TrackerParams params)

Methods

There are no methods.

AddedToFavoritesEvent

Class model for add to favourites event.

Declared In

com.synerise.sdk.event.model.products.AddedToFavoritesEvent

Declaration

public class AddedToFavoritesEvent extends Event

Properties

Property	Type	Optional	Default	Description
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker params

Initializers

The following constructors are available:

public AddedToFavoritesEvent(@NonNull String label)

public AddedToFavoritesEvent(@NonNull String label, @Nullable TrackerParams params)

Methods

There are no methods.

LoggedInEvent

Class model for Log in event.

Declared In

com.synerise.sdk.event.model.session.LoggedInEvent

Declaration

public class LoggedInEvent extends Event

Properties

Property	Type	Optional	Default	Description
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker params

Initializers

The following constructors are available:

public LoggedInEvent(@NonNull String label)

public LoggedInEvent(@NonNull String label, @Nullable TrackerParams params)

Methods

There are no methods.

LoggedOutEvent

Class model for Log out event.

Declared In

com.synerise.sdk.event.model.session.LoggedOutEvent

Declaration

public class LoggedOutEvent extends Event

Properties

Property	Type	Optional	Default	Description
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker params

Initializers

The following constructors are available:

public LoggedOutEvent(@NonNull String label)

public LoggedOutEvent(@NonNull String label, @Nullable TrackerParams params)

Methods

There are no methods.

RegisteredEvent

Class model for client register event. .

Declared In

com.synerise.sdk.event.model.session.RegisteredEvent

Declaration

public class RegisteredEvent extends Event

Properties

Property	Type	Optional	Default	Description
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker params

Initializers

The following constructors are available:

public RegisteredEvent(@NonNull String label)

public RegisteredEvent(@NonNull String label, @Nullable TrackerParams params)

Methods

There are no methods.

RecommendationEvent

Class model for recommendation events.

Declared In

com.synerise.sdk.event.model.ai.RecommendationEvent

Declaration

public class RecommendationEvent extends Event

Inheriting classes

RecommendationClickEvent
RecommendationSeenEvent

Properties

Property	Type	Optional	Default	Description
name	`String`	no	-	Product name
type	`String`	no	-	Event type
productId	`String`	no	-	Product ID
label	`String`	no	-	This value is currently unused
campaignId	`String`	no	-	Recommendation campaign ID
campaignHash	`String`	no	-	Recommendation campaign hash
params	`TrackerParams`	yes	-	Event tracker params

Note: The "productId", "name", "category", "url", "campaignId" , "campaignHash" keys are reserved by Synerise in params.

Initializers

public RecommendationEvent(@NonNull String type, @NonNull String label, @NonNull String productId, @NonNull String name,
                               @NonNull String campaignId, @NonNull String campaignHash,
                               @Nullable TrackerParams params)

Methods

This method defines the value of the category parameter.

public void setCategory(String category)

This method defines the value of the url parameter.

public void setUrl(String url)

RecommendationSeenEvent

Class model for recommendation seen event.

Declared In

com.synerise.sdk.event.model.ai.RecommendationSeenEvent

Declaration

public class RecommendationSeenEvent extends RecommendationEvent

Properties

Property	Type	Optional	Default	Description
name	`String`	no	-	Product name
productId	`String`	no	-	Product ID
campaignId	`String`	no	-	Recommendation campaign ID
campaignHash	`String`	no	-	Recommendation campaign hash
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker params

Note: The "productId", "name", "category", "url", "campaignId" , "campaignHash" keys are reserved by Synerise in params.

Initializers

The following constructors are available:

public RecommendationSeenEvent(@NonNull String label, @NonNull String productId, @NonNull String name,
                                   @NonNull String campaignId, @NonNull String campaignHash)

public RecommendationSeenEvent(@NonNull String label, @NonNull String productId, @NonNull String name,
                                   @NonNull String campaignId, @NonNull String campaignHash, @Nullable TrackerParams params)

Methods

There are no methods.

RecommendationClickEvent

Class model for recommendation click event.

Declared In

com.synerise.sdk.event.model.ai.RecommendationClickEvent

Declaration

public class RecommendationClickEvent extends RecommendationEvent

Properties

Property	Type	Optional	Default	Description
name	`String`	no	-	Product name
productId	`String`	no	-	Product ID
campaignId	`String`	no	-	Recommendation campaign ID
campaignHash	`String`	no	-	Recommendation campaign hash
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker params

Note: The "productId", "name", "category", "url", "campaignId" , "campaignHash" keys are reserved by Synerise in params.

Initializers

The following constructors are available:

public RecommendationClickEvent(@NonNull String label, @NonNull String productId, @NonNull String name,
                                    @NonNull String campaignId, @NonNull String campaignHash)

public RecommendationClickEvent(@NonNull String label, @NonNull String productId, @NonNull String name,
                                    @NonNull String campaignId, @NonNull String campaignHash, @Nullable TrackerParams params)

Methods

There are no methods.

VisitedScreenEvent

Class model for visited screen event.

Declared In

com.synerise.sdk.event.model.interaction.VisitedScreenEvent

Declaration

public class VisitedScreenEvent extends Event

Properties

Property	Type	Optional	Default	Description
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker params

Initializers

The following constructors are available:

public VisitedScreenEvent(@NonNull String label)

public VisitedScreenEvent(@NonNull String label, @Nullable TrackerParams params)

Methods

There are no methods.

HitTimerEvent

Class model for hit timer event.
Record a “customer hit timer” event. This could be used for profiling or activity time monitoring - you can send “hit timer” when your customer starts doing something and send it once again when they finish, but this time with a different time signature. Then you can use the Analytics module to measure, for example, average activity time.

Declared In

com.synerise.sdk.event.model.interaction.HitTimerEvent

Declaration

public class HitTimerEvent extends Event

Properties

Property	Type	Optional	Default	Description
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker params

Initializers

The following constructors are available:

public HitTimerEvent(@NonNull String label)

public HitTimerEvent(@NonNull String label, @Nullable TrackerParams params)

Methods

There are no methods.

SearchedEvent

Class model for client searched event.

Declared In

com.synerise.sdk.event.model.interaction.SearchedEvent

Declaration

public class SearchedEvent extends Event

Properties

Property	Type	Optional	Default	Description
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker params

Initializers

The following constructors are available:

public SearchedEvent(@NonNull String label)

public SearchedEvent(@NonNull String label, @Nullable TrackerParams params)

Methods

There are no methods.

SharedEvent

Class model for client shared event.

Declared In

com.synerise.sdk.event.model.interaction.SharedEvent

Declaration

public class SharedEvent extends Event

Properties

Property	Type	Optional	Default	Description
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker params

Initializers

The following constructors are available:

public SharedEvent(@NonNull String label)

public SharedEvent(@NonNull String label, @Nullable TrackerParams params)

Methods

There are no methods.

AppearedInLocationEvent

Class model for appeared in location event.

Declared In

com.synerise.sdk.event.model.interaction.AppearedInLocationEvent

Declaration

public class AppearedInLocationEvent extends Event

Note: This event will be transformed into client.location in the database.

Properties

Property	Type	Optional	Default	Description
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker params
lon	`Double`	no	-	Longitutde
lat	`Double`	no	-	Latitude

Note: The "lat" and "lon" keys are reserved by Synerise in params.

Initializers

The following constructors are available:

public AppearedInLocationEvent(@NonNull String label, double lat, double lon)

public AppearedInLocationEvent(@NonNull String label, double lat, double lon, @Nullable TrackerParams params)

Methods

There are no methods.

CrashEvent

Class model for crash event.

Declared In

com.synerise.sdk.event.model.crash.CrashEvent

Declaration

public class CrashEvent extends Event

Properties

Property	Type	Optional	Default	Description
label	`String`	no	-	This value is currently unused
params	`TrackerParams`	yes	-	Event tracker params

Initializers

There is a constructor.

public CrashEvent(@NonNull String label, @NonNull TrackerParams params)

Methods

There are no methods.