Events

Inherits From

Conforms To

Declaration

class Event: NSObject

Initializers

init(label: String)

init(label: String, params: TrackerParams)

CustomEvent

Represents a custom event.

Declared In

SNRCustomEvent.h

Inherits From

Conforms To

Declaration

class CustomEvent: Event

Initializers

init(type: String, label: String, action: String, params: TrackerParams?)

init(label: String, action: String, params: TrackerParams?)

init(label: String, action: String)

TrackerParams

Represents custom parameters that may be added to tracked events.

Declared In

SNRTrackerParams.h

Inherits From

Declaration

class TrackerParams: NSObject

Initializers

static func makeWithBuilder(_: ((TrackerParamsBuilder) -> ()))

TrackerParamsBuilder

Object that is used to create parameters for the event classes.

Declared In

SNRTrackerParamsBuilder.h

TrackerParams
Event

Inherits From

Declaration

class TrackerParamsBuilder: NSObject

Initializers

init()

Methods

func setString(_: String)

func setInt(_: Int)

func setDouble(_: Double)

func setFloat(_: Float)

func setBool(_: Bool)

func setObject(_: AnyClass)

PushClickedEvent

Represents a ‘client clicked push’ event.

This event is used for push message interaction tracking.

Declared In

SNRPushClickedEvent.h

Inherits From

Conforms To

Declaration

class PushClickedEvent: Event

PushViewedEvent

Represents a ‘client viewed push’ event.

This event is used for push message interaction tracking.

Declared In

SNRPushViewedEvent.h

Inherits From

Conforms To

Declaration

class PushViewedEvent: Event

PushCancelledEvent

Represents a ‘client viewed push’ event.

This event is used for push message interaction tracking.

Declared In

SNRCancelledPushEvent.h

Inherits From

Conforms To

Declaration

class CancelledPushEvent: Event

CartEvent

Main cart action abstract class for inheriting classes.

WARNING: This is an abstract class and it is not meant to be instantiated directly. You should use concrete CartEvent subclasses instead.

Declared In

SNRCartEvent.h

Inherits From

Conforms To

Declaration

class CartEvent: Event

Initializers

init(label: String, sku String, finalPrice: UnitPrice, quantity: Int, params: TrackerParams?)

init(label: String, sku: String, finalPrice: UnitPrice, quantity: Int)

Methods

Sets a product’s name.

func setName(_: String)

Sets a product’s category.

func setCategory(_: String)

Sets all of a product’s categories.

func setCategories(_: [String])

Sets if a product is offline or not.

func setOffline(_: Bool)

Sets a product’s regular price.

func setRegularPrice(_: UnitPrice)

Sets a product’s discounted price.

func setDiscountedPrice(_: UnitPrice)

Sets a product’s web page.

func setURL(_: URL)

Sets a product’s producer.

func setProducer(_: String)

ProductAddedToCartEvent

Represents a ‘client added product to cart’ event.

Declared In

SNRProductAddedToCartEvent.h

Inherits From

Event CartEvent

Conforms To

Declaration

class ProductAddedToCartEvent: CartEvent

ProductRemovedFromCartEvent

Represents a ‘client removed product from cart’ event.

Declared In

SNRProductRemovedFromCartEvent.h

Inherits From

Event CartEvent

Conforms To

Declaration

class ProductRemovedFromCartEvent: CartEvent

ProductViewedEvent

Represents a ‘client viewed product’ event.

Declared In

SNRProductViewedEvent.h

Inherits From

Conforms To

Declaration

class ProductViewedEvent: Event

Initializers

init(label: String, productName: String, productId: String, params: TrackerParams?)

Methods

Sets if a product is recommended or not.

func setIsRecommended(_: Bool)

Sets a product’s category.

func setCategory(_: String)

Sets a product’s web page.

func setURL(_: URL)

ProductAddedToFavoritesEvent

Represents a ‘client added product to favorites’ event.

Declared In

SNRProductAddedToFavoritesEvent.h

Inherits From

Conforms To

Declaration

class ProductAddedToFavoritesEvent: Event

LoggedInEvent

Represents a ‘client logged in’ event.

Declared In

SNRLoggedInEvent.h

Inherits From

Conforms To

Declaration

class LoggedInEvent: Event

LoggedOutEvent

Represents a ‘client logged out’ event.

Declared In

SNRLoggedOutEvent.h

Inherits From

Conforms To

Declaration

class LoggedOutEvent: Event

RegisteredEvent

Represents a ‘client registered’ event.

Declared In

SNRCancelledPushEvent.h

Inherits From

Conforms To

Declaration

class RegisteredEvent: Event

RecommendationEvent

Main recommendation abstract class for inheriting classes.

WARNING: This is an abstract class and it is not meant to be instantiated directly. You should use concrete RecommendationEvent subclasses instead.

Declared In

SNRRecommendationEvent.h

Inherits From

Conforms To

Declaration

class RecommendationEvent: Event

Initializers

init(label: String)

init(label: String, params: TrackerParams)

init(label: String, productName: String, productId: String, campaignID: String, campaignHash: String, params: TrackerParams?)

Methods

Set a product’s category.

func setCategory(_: String)

Set a product’s URL.

func setURL(_: URL)

RecommendationSeenEvent

Represents a ‘client saw a recommendation’ event.

Declared In

SNRRecommendationSeenEvent.h

Event RecommendationEvent

Inherits From

Conforms To

Declaration

class RecommendationSeenEvent: RecommendationEvent

RecommendationClickEvent

Represents a ‘client clicked a recommendation’ event.

Declared In

SNRRecommendationSeenEvent.h

Event RecommendationEvent

Inherits From

Conforms To

Declaration

class RecommendationClickEvent: RecommendationEvent

VisitedScreenEvent

Represents a ‘client visited screen’ event.

This can be used for mobile screen usage tracking.

Declared In

SNRVisitedScreenEvent.h

Inherits From

Conforms To

Declaration

class VisitedScreenEvent: Event

Initializers

init(label: String)

init(label: String, params: TrackerParams?)

HitTimerEvent

Represents a ‘client hit timer’ event.

This could be used for profiling or activity time monitoring - you can send a HitTimerEvent when a client starts doing something and send it once again when they finish, but this time with the different time signature. Then you can use our analytics engine to measure, for example, average activity time.

Declared In

SNRHitTimerEvent.h

Inherits From

Conforms To

Declaration

class HitTimerEvent: Event

Initializers

init(label: String)

init(label: String, params: TrackerParams?)

SearchedEvent

Represents a ‘client searched’ event.

Declared In

SNRSearchedEvent.h

Inherits From

Conforms To

Declaration

class SearchedEvent: Event

Initializers

init(label: String)

init(label: String, params: TrackerParams?)

SharedEvent

Represents a ‘client shared’ event.

Declared In

SNRSharedEvent.h

Inherits From

Conforms To

CCLocation
TrackerParams
TrackerParamsBuilder

Declaration

class SharedEvent: Event

Initializers

init(label: String)

init(label: String, params: TrackerParams?)

AppearedInLocationEvent

Represents a ‘client appeared in location’ event.

Declared In

SNRAppearedInLocationEvent.h

Inherits From

Conforms To

Declaration

class AppearedInLocationEvent: Event

Initializers

init(label: String, location: CCLocation)

init(label: String, location: CCLocation, params: TrackerParams?)

CrashEvent

Represents an ‘application crashed’ event.

Declared In

SNRCrashEvent.h

Inherits From

Conforms To

Declaration

class CrashEvent: Event

Initializers

init(label: String)

init(label: String, params: TrackerParams?)

Methods

Sets the exception name parameter.

func setExceptionName(_: String)

Sets the exception reason parameter.

func setExceptionReason(_: String)

Sets the exception stacktrace parameter.

func setExceptionStacktrace(_: String)

UnitPrice

Declared In

SNRUnitPrice.h

Inherits From

Conforms To