Events
TrackerParams
Represents custom parameters that may be added to tracked events.
Declared In:
Headers/SNRTrackerParams.h
Related To:
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:
Headers/SNRTrackerParamsBuilder.h
Related To:
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)
Event
Main event abstract class for inheriting classes.
Event subclasses instead.Declared In:
Headers/SNREvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
NSObject
Conforms To:
NSCopying
Declaration:
class Event: NSObject
Initializers:
init(label: String)
init(label: String, params: TrackerParams)
CustomEvent
DO NOT send transaction.charge events as custom events.
Transactions must be tracked with these endpoints:
/v4/transactions(single transaction)/v4/transactions/batch(multiple transactions)
Represents a custom event.
Declared In:
Headers/SNRCustomEvent.h
Related To:
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)
PushViewedEvent
Represents a ‘client viewed push’ event.
This event is used for push message interaction tracking.
Declared In:
Headers/SNRPushViewedEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
Event
Conforms To:
NSCopying
Declaration:
class PushViewedEvent: Event
PushClickedEvent
Represents a ‘client clicked push’ event.
This event is used for push message interaction tracking.
Declared In:
Headers/SNRPushClickedEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
Event
Conforms To:
NSCopying
Declaration:
class PushClickedEvent: Event
PushCancelledEvent
Represents a ‘client viewed push’ event.
This event is used for push message interaction tracking.
Declared In:
Headers/SNRCancelledPushEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
Event
Conforms To:
NSCopying
Declaration:
class CancelledPushEvent: Event
CartEvent
Main cart action abstract class for inheriting classes.
CartEvent subclasses instead.Declared In:
Headers/SNRCartEvent.h
Related To:
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:
This method sets a value for the name parameter.
func setName(_: String)
This method sets a value for the category parameter.
func setCategory(_: String)
This method sets values for the categories parameter.
func setCategories(_: [String])
This method sets a value for the offline parameter.
func setOffline(_: Bool)
This method sets the value of the regularPrice parameter.
func setRegularPrice(_: UnitPrice)
This method sets the value of the discountedPrice parameter.
func setDiscountedPrice(_: UnitPrice)
This method sets the value of the url parameter.
func setURL(_: URL)
This method sets the value of the producer parameter (producer can signify a brand of the item).
func setProducer(_: String)
UnitPrice
Declared In:
Headers/SNRUnitPrice.h
Inherits From:
NSObject
Conforms To:
NSCopying
Declaration:
class UnitPrice: NSObject
Initializers:
init(amount: Float)
init(amount: Float, locale: NSLocale)
ProductAddedToCartEvent
Represents a ‘client added product to cart’ event.
Declared In:
Headers/SNRProductAddedToCartEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
Event
CartEvent
Conforms To:
NSCopying
Declaration:
class ProductAddedToCartEvent: CartEvent
ProductRemovedFromCartEvent
Represents a ‘client removed product from cart’ event.
Declared In:
Headers/SNRProductRemovedFromCartEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
Event
CartEvent
Conforms To:
NSCopying
Declaration:
class ProductRemovedFromCartEvent: CartEvent
ProductViewedEvent
Represents a ‘client viewed product’ event.
Declared In:
Headers/SNRProductViewedEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
Event
Conforms To:
NSCopying
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)
This method sets a value for the category parameter.
func setCategory(_: String)
This method sets the value of the url parameter.
func setURL(_: URL)
ProductAddedToFavoritesEvent
Represents a ‘client added product to favorites’ event.
Declared In:
Headers/SNRProductAddedToFavoritesEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
Event
Conforms To:
NSCopying
Declaration:
class ProductAddedToFavoritesEvent: Event
LoggedInEvent
Represents a ‘client logged in’ event.
Declared In:
Headers/SNRLoggedInEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From: Event
Conforms To: NSCopying
Declaration:
class LoggedInEvent: Event
LoggedOutEvent
Represents a ‘client logged out’ event.
Declared In:
Headers/SNRLoggedOutEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
Event
Conforms To:
NSCopying
Declaration:
class LoggedOutEvent: Event
RegisteredEvent
Represents a ‘client registered’ event.
Declared In:
Headers/SNRCancelledPushEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
Event
Conforms To:
NSCopying
Declaration:
class RegisteredEvent: Event
RecommendationEvent
Main recommendation abstract class for inheriting classes.
RecommendationEvent subclasses instead.Declared In:
Headers/SNRRecommendationEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
Event
Conforms To:
NSCopying
Declaration:
class RecommendationEvent: Event
RecommendationViewEvent
Represents a ‘client viewed a recommendation’ event.
Declared In:
Headers/SNRRecommendationViewEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
Event
RecommendationEvent
Conforms To:
NSCopying
Declaration:
class RecommendationViewEvent: RecommendationEvent
Initializers:
init(label: String, campaignID: String, campaignHash: String, correlationId: String, params: TrackerParams?)
init(label: String, items: [String], campaignID: String, campaignHash: String, correlationId: String, params: TrackerParams?)
Methods:
This method sets a value for the items parameter.
func setItems(_ items: [String])
RecommendationSeenEvent
Represents a ‘client saw a recommendation’ event.
Declared In:
Headers/SNRRecommendationSeenEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
Event
RecommendationEvent
Conforms To:
NSCopying
Declaration:
class RecommendationSeenEvent: RecommendationEvent
Initializers:
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)
RecommendationClickEvent
Represents a ‘client clicked a recommendation’ event.
Declared In:
Headers/SNRRecommendationSeenEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
Event
RecommendationEvent
Conforms To:
NSCopying
Declaration:
class RecommendationClickEvent: RecommendationEvent
Initializers:
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)
VisitedScreenEvent
Represents a ‘client visited screen’ event.
This can be used for mobile screen usage tracking.
Declared In:
Headers/SNRVisitedScreenEvent.h
Related To:
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 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:
Headers/SNRHitTimerEvent.h
Related To:
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:
Headers/SNRSearchedEvent.h
Related To:
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:
Headers/SNRSharedEvent.h
Related To:
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:
Headers/SNRAppearedInLocationEvent.h
Related To:
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:
Headers/SNRCrashEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
Event
Conforms To:
NSCopying
Declaration:
class CrashEvent: Event
Initializers:
init(label: String)
init(label: String, params: TrackerParams?)
Methods:
This method sets the exception’s name parameter.
func setExceptionName(_: String)
This method sets the exception’s reason parameter.
func setExceptionReason(_: String)
This method sets the exception’s stacktrace parameter.
func setExceptionStacktrace(_: String)
