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
@interface SNRTrackerParams : NSObject
Initializers:
static func makeWithBuilder(_: ((TrackerParamsBuilder) -> ()))
+ (instancetype)makeWithBuilder:(nonnull void (^)(SNRTrackerParamsBuilder *builder))buildBlock
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
@interface SNRTrackerParamsBuilder : NSObject
Initializers:
init()
- (instancetype)init
Methods:
func setString(_: String)
- (void)setString:(nonnull NSString *)string forKey:(nonnull NSString *)key
func setInt(_: Int)
- (void)setInt:(NSInteger)integer forKey:(nonnull NSString *)key
func setDouble(_: Double)
- (void)setDouble:(double)doubleValue forKey:(nonnull NSString *)key
func setFloat(_: Float)
- (void)setFloat:(float)floatValue forKey:(nonnull NSString *)key
func setBool(_: Bool)
- (void)setBool:(BOOL)boolValue forKey:(nonnull NSString *)key
func setObject(_: AnyClass)
- (void)setObject:(nonnull id)object forKey:(nonnull NSString *)key
Event
Main event abstract class for inheriting classes.
This is an abstract class and it is not meant to be instantiated directly. You should use concrete Event subclasses instead.
Declared In:
Headers/SNREvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
NSObject
Conforms To:
NSCopying
Declaration:
class Event: NSObject
@interface SNREvent : NSObject
Initializers:
init(label: String)
- (instancetype)initWithLabel:(nonnull NSString *)label
init(label: String, params: TrackerParams)
- (instancetype)initWithLabel:(nonnull NSString *)label andParams:(nullable SNRTrackerParams *)params
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
@interface SNRCustomEvent : SNREvent
Initializers:
init(type: String, label: String, action: String, params: TrackerParams?)
- (instancetype)initWithType:(nonnull NSString *)type label:(nonnull NSString *)label action:(nonnull NSString *)action andParams:(nullable SNRTrackerParams *)params
init(label: String, action: String, params: TrackerParams?)
- (instancetype)initWithLabel:(nonnull NSString *)label action:(nonnull NSString *)action andParams:(nullable SNRTrackerParams *)params
init(label: String, action: String)
- (instancetype)initWithLabel:(nonnull NSString *)label action:(nonnull NSString *)action
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
@interface SNRPushViewedEvent : SNREvent
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
@interface SNRPushClickedEvent : SNREvent
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
@interface SNRCancelledPushEvent : SNREvent
CartEvent
Main cart action abstract class for inheriting classes.
This is an abstract class and it is not meant to be instantiated directly. You should use concrete CartEvent subclasses instead.
Declared In:
Headers/SNRCartEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
Event
Conforms To:
NSCopying
Declaration:
class CartEvent: Event
@interface SNRCartEvent : SNREvent
Initializers:
init(label: String, sku String, finalPrice: UnitPrice, quantity: Int, params: TrackerParams?)
- (instancetype)initWithLabel:(nonnull NSString *)label sku:(nonnull NSString *)sku finalPrice:(nonnull SNRUnitPrice *)unitPrice quantity:(NSInteger)quantity andParams:(nullable SNRTrackerParams *)params
init(label: String, sku: String, finalPrice: UnitPrice, quantity: Int)
- (instancetype)initWithLabel:(nonnull NSString *)label sku:(nonnull NSString *)sku finalPrice:(nonnull SNRUnitPrice *)unitPrice quantity:(NSInteger)quantity
Methods:
This method sets a value for the name parameter.
func setName(_: String)
- (void)setName:(nonnull NSString *)name
This method sets a value for the category parameter.
func setCategory(_: String)
- (void)setCategory:(nonnull NSString *)category
This method sets values for the categories parameter.
func setCategories(_: [String])
- (void)setCategories:(nonnull NSArray<NSString *> *)categories
This method sets a value for the offline parameter.
func setOffline(_: Bool)
- (void)setOffline:(BOOL)isOffline
This method sets the value of the regularPrice parameter.
func setRegularPrice(_: UnitPrice)
- (void)setRegularPrice:(nonnull SNRUnitPrice *)price
This method sets the value of the discountedPrice parameter.
func setDiscountedPrice(_: UnitPrice)
- (void)setDiscountedPrice:(nonnull SNRUnitPrice *)price
This method sets the value of the url parameter.
func setURL(_: URL)
- (void)setURL:(nonnull NSURL *)url
This method sets the value of the producer parameter (producer can signify a brand of the item).
func setProducer(_: String)
- (void)setProducer:(nonnull NSString *)producer
UnitPrice
Declared In:
Headers/SNRUnitPrice.h
Inherits From:
NSObject
Conforms To:
NSCopying
Declaration:
class UnitPrice: NSObject
@interface SNRUnitPrice : NSObject
Initializers:
init(amount: Float)
- (instancetype)initWithAmount:(float)amount
init(amount: Float, locale: NSLocale)
- (instancetype)initWithAmount:(float)amount locale:(nonnull NSLocale *)locale
ProductAddedToCartEvent
Represents a 'client added product to cart' event.
Declared In:
Headers/SNRProductAddedToCartEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Conforms To:
NSCopying
Declaration:
class ProductAddedToCartEvent: CartEvent
@interface SNRProductAddedToCartEvent : SNRCartEvent
ProductRemovedFromCartEvent
Represents a 'client removed product from cart' event.
Declared In:
Headers/SNRProductRemovedFromCartEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Conforms To:
NSCopying
Declaration:
class ProductRemovedFromCartEvent: CartEvent
@interface SNRProductRemovedFromCartEvent : SNRCartEvent
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
@interface SNRProductViewedEvent : SNREvent
Initializers:
init(label: String, productName: String, productId: String, params: TrackerParams?)
- (instancetype)initWithLabel:(nonnull NSString *)label productName:(nonnull NSString *)productName productId:(nonnull NSString *)productId andParams:(nullable SNRTrackerParams *)params
Methods: Sets if a product is recommended or not.
func setIsRecommended(_: Bool)
- (void)setIsRecommended:(BOOL)isRecommended
This method sets a value for the category parameter.
func setCategory(_: String)
- (void)setCategory:(NSString *)category
This method sets the value of the url parameter.
func setURL(_: URL)
- (void)setURL:(NSURL *)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
@interface SNRProductAddedToFavoritesEvent : SNREvent
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
@interface SNRLoggedInEvent : SNREvent
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
@interface SNRLoggedOutEvent : SNREvent
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
@interface SNRRegisteredEvent : SNREvent
RecommendationEvent
Main recommendation abstract class for inheriting classes.
This is an abstract class and it is not meant to be instantiated directly. You should use concrete RecommendationEvent subclasses instead.
Declared In:
Headers/SNRRecommendationEvent.h
Related To:
TrackerParams
TrackerParamsBuilder
Inherits From:
Event
Conforms To:
NSCopying
Declaration:
class RecommendationEvent: Event
@interface SNRRecommendationEvent : SNREvent
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
@interface SNRRecommendationViewEvent : SNRRecommendationEvent
Initializers:
init(label: String, campaignID: String, campaignHash: String, correlationId: String, params: TrackerParams?)
- (instancetype)initWithLabel:(NSString *)label campaignID:(NSString *)campaignID campaignHash:(NSString *)campaignHash correlationId:(NSString *)correlationId andParams:(nullable SNRTrackerParams *)params
init(label: String, items: [String], campaignID: String, campaignHash: String, correlationId: String, params: TrackerParams?)
- (instancetype)initWithLabel:(NSString *)label items:(nullable NSArray<NSString *> *)items campaignID:(NSString *)campaignID campaignHash:(NSString *)campaignHash correlationId:(NSString *)correlationId andParams:(nullable SNRTrackerParams *)params
Methods:
This method sets a value for the items parameter.
func setItems(_ items: [String])
- (void)setItems:(NSArray<NSString *> *)items
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
@interface SNRRecommendationSeenEvent : SNRRecommendationEvent
Initializers:
init(label: String, productName: String, productId: String, campaignID: String, campaignHash: String, params: TrackerParams?)
- (instancetype)initWithLabel:(nonnull NSString *)label productName:(nonnull NSString *)productName productId:(nonnull NSString *)productId campaignID:(nonnull NSString *)campaignID campaignHash:(nonnull NSString *)campaignHash andParams:(nullable SNRTrackerParams *)params
Methods: Set a product's category.
func setCategory(_: String)
- (void)setCategory:(nonnull NSString *)category
Set a product's URL.
func setURL(_: URL)
- (void)setURL:(nonnull NSURL *)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
@interface SNRRecommendationClickEvent : SNRRecommendationEvent
Initializers:
init(label: String, productName: String, productId: String, campaignID: String, campaignHash: String, params: TrackerParams?)
- (instancetype)initWithLabel:(nonnull NSString *)label productName:(nonnull NSString *)productName productId:(nonnull NSString *)productId campaignID:(nonnull NSString *)campaignID campaignHash:(nonnull NSString *)campaignHash andParams:(nullable SNRTrackerParams *)params
Methods: Set a product's category.
func setCategory(_: String)
- (void)setCategory:(nonnull NSString *)category
Set a product's URL.
func setURL(_: URL)
- (void)setURL:(nonnull NSURL *)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
@interface SNRVisitedScreenEvent : SNREvent
Initializers:
init(label: String)
- (instancetype)initWithLabel:(nonnull NSString *)label
init(label: String, params: TrackerParams?)
- (instancetype)initWithLabel:(nonnull NSString *)label andParams:(nullable SNRTrackerParams *)params
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
@interface SNRHitTimerEvent : SNREvent
Initializers:
init(label: String)
- (instancetype)initWithLabel:(nonnull NSString *)label
init(label: String, params: TrackerParams?)
- (instancetype)initWithLabel:(nonnull NSString *)label andParams:(nullable SNRTrackerParams *)params
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
@interface SNRSearchedEvent : SNREvent
Initializers:
init(label: String)
- (instancetype)initWithLabel:(nonnull NSString *)label
init(label: String, params: TrackerParams?)
- (instancetype)initWithLabel:(nonnull NSString *)label andParams:(nullable SNRTrackerParams *)params
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
@interface SNRSharedEvent : SNREvent
Initializers:
init(label: String)
- (instancetype)initWithLabel:(nonnull NSString *)label
init(label: String, params: TrackerParams?)
- (instancetype)initWithLabel:(nonnull NSString *)label andParams:(nullable SNRTrackerParams *)params
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
@interface SNRAppearedInLocationEvent : SNREvent
Initializers:
init(label: String, location: CCLocation)
- (instancetype)initWithLabel:(nonnull NSString *)label andLocation:(nonnull CLLocation *)location
init(label: String, location: CCLocation, params: TrackerParams?)
- (instancetype)initWithLabel:(nonnull NSString *)label andLocation:(nonnull CLLocation *)location andParams:(nullable SNRTrackerParams *)params
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
@interface SNRCrashEvent : SNREvent
Initializers:
init(label: String)
- (instancetype)initWithLabel:(nonnull NSString *)label
init(label: String, params: TrackerParams?)
- (instancetype)initWithLabel:(nonnull NSString *)label andParams:(nullable SNRTrackerParams *)params
Methods:
This method sets the exception's name parameter.
func setExceptionName(_: String)
- (void)setExceptionName:(nonnull NSString *)exceptionName
This method sets the exception's reason parameter.
func setExceptionReason(_: String)
- (void)setExceptionReason:(nonnull NSString *)exceptionReason
This method sets the exception's stacktrace parameter.
func setExceptionStacktrace(_: String)
- (void)setExceptionStacktrace:(nonnull NSString *)exceptionStacktrace