Events

Event

Main event abstract class for inheriting classes.

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

Declared In

SNREvent.h

TrackerParams
TrackerParamsBuilder

Inherits From

NSObject

Conforms To

NSCopying

Declaration

class Event: NSObject

Initializers

init(label: String)

init(label: String, params: TrackerParams)


CustomEvent

Represents a custom event.

Declared In

SNRCustomEvent.h

TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

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

Event

Inherits From

NSObject

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

NSObject

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

TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

Declaration

class PushClickedEvent: Event


PushViewedEvent

Represents a ‘client viewed push’ event.

This event is used for push message interaction tracking.

Declared In

SNRPushViewedEvent.h

TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

Declaration

class PushViewedEvent: Event


PushCancelledEvent

Represents a ‘client viewed push’ event.

This event is used for push message interaction tracking.

Declared In

SNRCancelledPushEvent.h

TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

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

TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

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)



AddedProductToCartEvent

Represents a ‘client added product to cart’ event.

Declared In

SNRAddedProductToCartEvent.h

TrackerParams
TrackerParamsBuilder

Inherits From

Event CartEvent

Conforms To

NSCopying

Declaration

class AddedProductToCartEvent: CartEvent


RemovedProductFromCartEvent

Represents a ‘client removed product from cart’ event.

Declared In

SNRRemovedProductFromCartEvent.h

TrackerParams
TrackerParamsBuilder

Inherits From

Event CartEvent

Conforms To

NSCopying

Declaration

class RemovedProductFromCartEvent: CartEvent


AddedProductToFavoritesEvent

Represents a ‘client added product to favorites’ event.

Declared In

SNRAddedProductToFavoritesEvent.h

TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

Declaration

class AddedProductToFavoritesEvent: Event


ProductViewEvent

Represents a ‘client viewed product’ event.

Declared In

SNRProductViewEvent.h

TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

Declaration

class ProductViewEvent: 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)



LoggedInEvent

Represents a ‘client logged in’ event.

Declared In

SNRLoggedInEvent.h

TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

Declaration

class LoggedInEvent: Event


LoggedOutEvent

Represents a ‘client logged out’ event.

Declared In

SNRLoggedOutEvent.h

TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

Declaration

class LoggedOutEvent: Event


RegisteredEvent

Represents a ‘client registered’ event.

Declared In

SNRCancelledPushEvent.h

TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

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

TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

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 has seen recommendation’ event.

Declared In

SNRRecommendationSeenEvent.h

TrackerParams
TrackerParamsBuilder

Inherits From

Event RecommendationEvent

Conforms To

NSCopying

Declaration

class RecommendationSeenEvent: RecommendationEvent


RecommendationClickEvent

Represents a ‘client has clicked recommendation’ event.

Declared In

SNRRecommendationSeenEvent.h

TrackerParams
TrackerParamsBuilder

Inherits From

Event RecommendationEvent

Conforms To

NSCopying

Declaration

class RecommendationClickEvent: RecommendationEvent


VisitedScreenEvent

Represents a ‘client visited screen’ event.

This can be used for mobile screen usage tracking.

Declared In

SNRVisitedScreenEvent.h

TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

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 your 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

TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

Declaration

class HitTimerEvent: Event

Initializers

init(label: String)

init(label: String, params: TrackerParams?)


SearchedEvent

Represents a ‘client searched’ event.

Declared In

SNRSearchedEvent.h

TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

Declaration

class SearchedEvent: Event

Initializers

init(label: String)

init(label: String, params: TrackerParams?)


SharedEvent

Represents a ‘client shared’ event.

Declared In

SNRSharedEvent.h

TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

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

CCLocation
TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

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

TrackerParams
TrackerParamsBuilder

Inherits From

Event

Conforms To

NSCopying

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

NSObject

Conforms To

NSCopying

Declaration

class UnitPrice: NSObject

Initializers

init(amount: Float)

init(amount: Float, locale: NSLocale)
😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.