Events

Event

Class model for events.

Declared In:
com.synerise.sdk.event.Event

Declaration:

public abstract class Event implements Serializable

abstract class Event : Serializable

Properties:

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

class CustomEvent : Event

Properties:

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

class AppStartedEvent : Event

Properties:

Parameters tracked

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

class AutoTrackingEvent : Event

Properties:

There are no public properties.

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

class ViewedPushEvent : Event

Properties:

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

class ClickedPushEvent : Event

Properties:

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

class CancelledPushEvent : Event

Properties:

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

abstract class CartEvent : Event

Inheriting classes

AddedToCartEvent RemovedFromCartEvent

Properties:

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

class AddedToCartEvent : CartEvent

Properties:

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

class RemovedFromCartEvent : CartEvent

Properties:

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

class ProductEvent : Event

Inheriting classes

ProductViewEvent

Properties:

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

class ProductViewEvent : ProductEvent

Properties:

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

class AddedToFavoritesEvent : Event

Properties:

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

class LoggedInEvent : Event

Properties:

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

class LoggedOutEvent : Event

Properties:

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

class RegisteredEvent : Event

Properties:

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

class RecommendationEvent : Event

Inheriting classes

RecommendationClickEvent
RecommendationSeenEvent

Properties:

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)

RecommendationViewEvent

Class model for recommendation events.

Declared In:
com.synerise.sdk.event.model.ai.RecommendationViewEvent

Declaration:

public class RecommendationViewEvent extends Event

class RecommendationViewEvent : Event

Properties:

Initializers:

public RecommendationViewEvent(@NonNull String productId, @NonNull String correlationId,
                                   @NonNull String campaignId, @NonNull String campaignHash)

public RecommendationViewEvent(@NonNull String label, @NonNull String productId, @NonNull String correlationId,
                                   @NonNull String campaignId, @NonNull String campaignHash, @Nullable TrackerParams params)
    
public RecommendationViewEvent(@NonNull List<String> items, @NonNull String correlationId,
                                   @NonNull String campaignId, @NonNull String campaignHash)

public RecommendationViewEvent(@NonNull String label, @NonNull List<String> items, @NonNull String correlationId,
                                   @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

class RecommendationSeenEvent : RecommendationEvent

Properties:

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

class RecommendationClickEvent : RecommendationEvent

Properties:

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

class VisitedScreenEvent : Event

Properties:

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

class HitTimerEvent : Event

Properties:

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

class SearchedEvent : Event

Properties:

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

class SharedEvent : Event

Properties:

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

class AppearedInLocationEvent : Event

Properties:

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

class CrashEvent : Event

Properties:

Initializers:

There is a constructor.

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

Methods:

There are no methods.