Events List
Event class
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 | - | Event label |
clientParams | HashMap<String, Object> |
no | - | Client parameters |
params | HashMap<String, Object> |
no | - | Event params |
Initializers
There are no initializers.
Methods
Get label.
public String getLabel()
Get action.
public String getAction()
Get client params.
public HashMap<String, Object> getClientParams()
Get event time.
public Date getEventTime()
Get type.
public String getType()
Get params.
public HashMap<String, Object> getParams()
Product event class
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 | - | Event label |
params | TrackerParams |
yes | - | Event tracker params |
"productId"
, "name"
, "category"
, "url"
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
Set the category.
public void setCategory(String category)
Set the URL.
public void setUrl(String url)
Product view event class
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 | - | Event label |
params | TrackerParams |
yes | - | Event tracker params |
"productId"
, "name"
, "category"
, "url"
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.
Recommendation event class
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 | - | Event label |
campaignId | String |
no | - | Recommendation campaign ID |
campaignHash | String |
no | - | Recommendation campaign hash |
params | TrackerParams |
yes | - | Event tracker params |
"productId"
, "name"
, "category"
, "url"
, "campaignId"
, "campaignHash"
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
Set the category.
public void setCategory(String category)
Set the URL.
public void setUrl(String url)
Recommendation click event class
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 | - | Event label |
params | TrackerParams |
yes | - | Event tracker params |
"productId"
, "name"
, "category"
, "url"
, "campaignId"
, "campaignHash"
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.
Recommendation seen event class
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 | - | Event label |
params | TrackerParams |
yes | - | Event tracker params |
"productId"
, "name"
, "category"
, "url"
, "campaignId"
, "campaignHash"
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.
Crash event class
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 | - | Event label |
params | TrackerParams |
yes | - | Event tracker params |
Initializers
There is a constructor.
public CrashEvent(@NonNull String label, @NonNull TrackerParams params)
Methods
There are no methods.
Custom event class
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 | - | Event label |
action | String |
no | - | Event action |
params | TrackerParams |
yes | - | Event tracker params |
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.
Appeared in location event class
Class model for appeared in location event.
Declared In
com.synerise.sdk.event.model.interaction.AppearedInLocationEvent
Declaration
public class AppearedInLocationEvent extends Event
client.location
in the database.Properties
Property | Type | Optional | Default | Description |
---|---|---|---|---|
label | String |
no | - | Event label |
params | TrackerParams |
yes | - | Event tracker params |
lon | Double |
no | - | Longitutde |
lat | Double |
no | - | Latitude |
"lat"
, "lon"
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.
Application started event class
Class model for application started.
Declared In
com.synerise.sdk.event.model.interaction.AppStartedEvent
Declaration
public class AppStartedEvent extends Event
Properties
Property | Type | Optional | Default | Description |
---|---|---|---|---|
label | String |
no | - | Event label |
params | TrackerParams |
yes | - | Event tracker params |
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.
Autotracking event class
Class model for autotracking events.
Declared In
com.synerise.sdk.event.model.interaction.AutoTrackingEvent
Declaration
public class AutoTrackingEvent extends Event
Properties
There are no public properties.
"screen.interaction"
and "screen.view"
actions are sent by the autotracking module.Initializers
There are no public constructors.
Methods
There are no methods.
Hit timer event class
Class model for hit timer event.
Record a “client hit timer” event. This could be used for profiling or activity time monitoring - you can send “hit timer”
when your client starts doing something and send it once again when they finish, but this time with a different time signature.
Then you can use our analytics engine 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 | - | Event label |
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.
Searched event class
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 | - | Event label |
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.
Shared event class
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 | - | Event label |
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.
Visited screen event class
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 | - | Event label |
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.
Added to favourites event class
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 | - | Event label |
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.
Cart event class
Class model for cart event.
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 product |
label | String |
no | - | Event label |
finalPrice | UnitPrice |
no | - | Final price of the product |
quantity | int |
no | - | Quantity of the product |
params | TrackerParams |
yes | - | Event tracker params |
"sku"
, "name"
, "category"
, "categories"
, "offline"
, "regularUnitPrice"
, "discountedUnitPrice"
, "finalUnitPrice"
, "url"
, "producer"
, "quantity"
are reserved by Synerise in params.Initializers
CartEvent(@NonNull String type, @NonNull String label, @NonNull String sku, @NonNull UnitPrice finalPrice, int quantity,
@Nullable TrackerParams params)
Methods
Set name.
public void setName(String name)
Set category.
public void setCategory(String category)
Set categories.
public void setCategories(List<String> categories)
Set offline.
public void setOffline(boolean offline)
Set regularPrice.
public void setRegularPrice(UnitPrice regularPrice)
Set discountedPrice.
public void setDiscountedPrice(UnitPrice discountedPrice)
Set url.
public void setUrl(String url)
Set producer.
public void setProducer(String producer)
Added to cart event class
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 | - | Event label |
finalPrice | UnitPrice |
no | - | Final price of the product |
quantity | int |
no | - | Quantity of the product |
params | TrackerParams |
yes | - | Event tracker params |
"sku"
, "name"
, "category"
, "categories"
, "offline"
, "regularUnitPrice"
, "discountedUnitPrice"
, "finalUnitPrice"
, "url"
, "producer"
, "quantity"
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
Set name.
public void setName(String name)
Set category.
public void setCategory(String category)
Set categories.
public void setCategories(List<String> categories)
Set offline.
public void setOffline(boolean offline)
Set regularPrice.
public void setRegularPrice(UnitPrice regularPrice)
Set discountedPrice.
public void setDiscountedPrice(UnitPrice discountedPrice)
Set url.
public void setUrl(String url)
Set producer.
public void setProducer(String producer)
Remove from cart event class
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 | - | Event label |
finalPrice | UnitPrice |
no | - | Final price of the product |
quantity | int |
no | - | Quantity of the product |
params | TrackerParams |
yes | - | Event tracker params |
"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
Set name.
public void setName(String name)
Set category.
public void setCategory(String category)
Set categories.
public void setCategories(List<String> categories)
Set offline.
public void setOffline(boolean offline)
Set regularPrice.
public void setRegularPrice(UnitPrice regularPrice)
Set discountedPrice.
public void setDiscountedPrice(UnitPrice discountedPrice)
Set url.
public void setUrl(String url)
Set producer.
public void setProducer(String producer)
Cancelled push event class
Class model for Cancelled Push event.
Declared In
com.synerise.sdk.event.model.push.CancelledPushEvent
Declaration
public class CancelledPushEvent extends Event
Properties
Property | Type | Optional | Default | Description |
---|---|---|---|---|
label | String |
no | - | Event label |
params | TrackerParams |
yes | - | Event tracker params |
Initializers
The following constructors are available:
public CancelledPushEvent(@NonNull String label)
public CancelledPushEvent(@NonNull String label, @Nullable TrackerParams params)
Methods
There are no methods.
Clicked push event class
Class model for Clicked Push 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 | - | Event label |
params | TrackerParams |
yes | - | Event tracker params |
Initializers
The following constructors are available:
public ClickedPushEvent(@NonNull String label)
public ClickedPushEvent(@NonNull String label, @Nullable TrackerParams params)
Methods
There are no methods.
Viewed push event class
Class model for Viewed Push 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 | - | Event label |
params | TrackerParams |
yes | - | Event tracker params |
Initializers
The following constructors are available:
public ViewedPushEvent(@NonNull String label)
public ViewedPushEvent(@NonNull String label, @Nullable TrackerParams params)
Methods
There are no methods.
Logged in event class
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 | - | Event label |
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.
Logged out event class
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 | - | Event label |
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.
Registered event class
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 | - | Event label |
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.