Tracker Class Reference
Tracker
public class Tracker: NSObjectWrapper class for tracking usage of your application
-
Tracker current delegate
Declaration
Swift
@objc public var delegate: TrackerDelegate? -
Sets Tracker in debug mode and display debugger window
Declaration
Swift
@objc public var enableDebugger: Bool = false
-
Return Publisher instance
Declaration
Swift
@objc fileprivate(set) public lazy var publishers: Publishers = Publishers(tracker: self)
-
Return SelfPromotions instance
Declaration
Swift
@objc fileprivate(set) public lazy var selfPromotions: SelfPromotions = SelfPromotions(tracker: self)
-
Return Identified visitor instance
Declaration
Swift
@objc fileprivate(set) public lazy var identifiedVisitor: IdentifiedVisitor = IdentifiedVisitor(tracker: self)
-
Dynamic Screen tracking
Declaration
Swift
@objc fileprivate(set) public lazy var dynamicScreens: DynamicScreens = DynamicScreens(tracker: self)
-
Return CustomObjects instance
Declaration
Swift
@objc fileprivate(set) public lazy var customObjects: CustomObjects = CustomObjects(tracker: self)
-
Return CustomVar instance - Deprecated : customVars is now only available as a screen object property.
Declaration
Swift
fileprivate(set) public lazy var customVars: CustomVars = CustomVars(tracker: self)
-
Return InternalSearch instance - Deprecated : internalSearch is now only available as a screen object property.
Declaration
Swift
fileprivate(set) public lazy var internalSearches: InternalSearches = InternalSearches(tracker: self)
-
Return CustomTreeStructures instance - Deprecated : customTreeStructures is now only available as a screen object property.
Declaration
Swift
fileprivate(set) public lazy var customTreeStructures: CustomTreeStructures = CustomTreeStructures(tracker: self)
-
Return MediaPlayers instance
Declaration
Swift
@objc fileprivate(set) public lazy var mediaPlayers: MediaPlayers = MediaPlayers(tracker: self)
-
Initialisation with default configuration
Declaration
Swift
public convenience override init() -
Initialisation with a custom configuration
Declaration
Swift
@objc public init(configuration: [String: String])
-
Get the current configuration (read-only)
Declaration
Swift
@objc public var config: [String:String] -
Set a new configuration
Declaration
Swift
@objc public func setConfig(_ configuration: [String: String], override: Bool = false, sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?) -
Set one new key/value pair
Declaration
Swift
@objc public func setConfig(_ key: String, value: String, sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?) -
Set a new log
Declaration
Swift
@objc public func setLog(_ log: String, sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?) -
Set a new secure log
Declaration
Swift
@objc public func setSecuredLog(_ securedLog: String, sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?) -
Set a new domain
Declaration
Swift
@objc public func setDomain(_ domain: String, sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?) -
Set a new site ID
Declaration
Swift
@objc public func setSiteId(_ siteId: Int, sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?) -
Set the offline mode
Declaration
Swift
public func setOfflineMode(_ offlineMode: OfflineModeKey, sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?) -
Enable the secure mode (use HTTPS with secured log)
Declaration
Swift
@objc public func setSecureModeEnabled(_ enabled: Bool, sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?) -
Set a new identifier type
Declaration
Swift
public func setIdentifierType(_ identifierType: IdentifierTypeKey, sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?) -
Enable hash user id (SHA-256 with salt to ensure anonymity)
Declaration
Swift
@objc public func setHashUserIdEnabled(_ enabled: Bool, sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?) -
Set a new Plugin
Declaration
Swift
public func setPlugins(_ pluginNames: [PluginKey], sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?) -
Enable background task
Declaration
Swift
@objc public func setBackgroundTaskEnabled(_ enabled: Bool, sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?) -
Set new pixel path
Declaration
Swift
@objc public func setPixelPath(_ pixelPath: String, sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?) -
Enable persistent identified visitor (identification data available for all sessions)
Declaration
Swift
@objc public func setPersistentIdentifiedVisitorEnabled(_ enabled: Bool, sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?) -
Enable the campaign persistance
Declaration
Swift
@objc public func setCampaignLastPersistenceEnabled(_ enabled: Bool, sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?) -
Set a new campaign lifetime
Declaration
Swift
@objc public func setCampaignLifetime(_ lifetime: Int, sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?) -
Set a new Session duration
Declaration
Swift
@objc public func setSessionBackgroundDuration(_ duration: Int, sync: Bool = false, completionHandler: ((_ isSet: Bool) -> Void)?)
-
Add a parameter in the hit querystring
Declaration
Swift
public func setParam(_ key: String, value: @escaping ()->(String)) -> Tracker -
Add a parameter in the hit querystring
Declaration
Swift
public func setParam(_ key: String, value: @escaping ()->(String), options: ParamOption) -> Tracker -
Add a parameter in the hit querystring
Declaration
Swift
public func setParam(_ key: String, value: String) -> Tracker -
Add a parameter in the hit querystring
Declaration
Swift
public func setParam(_ key: String, value: String, options: ParamOption) -> Tracker -
Add a parameter in the hit querystring
Declaration
Swift
public func setParam(_ key: String, value: Int) -> Tracker -
Add a parameter in the hit querystring
Declaration
Swift
public func setParam(_ key: String, value: Int, options: ParamOption) -> Tracker -
Add a parameter in the hit querystring
Declaration
Swift
public func setParam(_ key: String, value: Float) -> Tracker -
Add a parameter in the hit querystring
Declaration
Swift
public func setParam(_ key: String, value: Float, options: ParamOption) -> Tracker -
Add a parameter in the hit querystring
Declaration
Swift
public func setParam(_ key: String, value: Double) -> Tracker -
Add a parameter in the hit querystring
Declaration
Swift
public func setParam(_ key: String, value: Double, options: ParamOption) -> Tracker -
Add a parameter in the hit querystring
Declaration
Swift
public func setParam(_ key: String, value: Bool) -> Tracker -
Add a parameter in the hit querystring
Declaration
Swift
public func setParam(_ key: String, value: Bool, options: ParamOption) -> Tracker -
Add a parameter in the hit querystring
Declaration
Swift
public func setParam(_ key: String, value: [Any]) -> Tracker -
Add a parameter in the hit querystring
Declaration
Swift
public func setParam(_ key: String, value: [Any], options: ParamOption) -> Tracker -
Add a parameter in the hit querystring
Declaration
Swift
public func setParam(_ key: String, value: [String: Any]) -> Tracker -
Add a parameter in the hit querystring
Declaration
Swift
public func setParam(_ key: String, value: [String: Any], options: ParamOption) -> Tracker -
Remove a parameter from the hit querystring
Declaration
Swift
@objc public func unsetParam(_ param: String) -
Remove the screen context: Use only for specific issue mark screenA, mark touchA, dont mark screenB, mark touchB. touchB will be no longer attached to screenA
Declaration
Swift
@objc public func resetScreenContext()
-
Sends all tracking objects added
Declaration
Swift
@objc public func dispatch()
-
Get the user id
Declaration
Swift
@objc public func getUserId() -> String -
Set a custom user id
Declaration
Swift
@objc public func setUserId(userId: String)
-
Disable user identification.
Declaration
Swift
@objc public class var doNotTrack: Bool
-
Set tracker crash handler Use only if you don’t already use another crash analytics solution Once enabled, tracker crash handler can’t be disabled until tracker instance termination
Declaration
Swift
@objc public class var handleCrash: Bool