Obj-C SDK - BTTracker

Summary:

This document contains information regarding the BTTracker Class for the iOS SDK. Contents include:

• BTTracker Introduction
• Methods
• Method Definitions

BTTracker Introduction

Includes: 

<Foundation/Foundation.h>

Introduction:

 An object responsible for submitting BTTimer instances to Blue Triangle for processing.

Methods

+allGlobalFields
+clearGlobalField:
+setGlobalField:boolValue:
+setGlobalField:doubleValue:
+setGlobalField:floatValue:
+setGlobalField:integerValue:
+setGlobalField:stringValue:
+setGlobalUserID:
+setSessionID:
+setSiteID:
+sharedTracker
+submitTimer:

Method Definitions

allGlobalFields

(NSDictionary *)allGlobalFields;

Return Value: 

Returns a Dictionary with all the fields currently.

Discussion:

Get all the fields currently associated with this timer.

clearGlobalField:

(void)clearGlobalField:(NSString *)fieldName;

Discussion:

Set a global field to be applied to all trackers

setGlobalField:boolValue:

(void)setGlobalField:(NSString *)fieldName boolValue:(BOOL)boolValue;

Discussion:

Set a global field to be applied to all trackers

setGlobalField:doubleValue:

(void)setGlobalField:(NSString *)fieldName doubleValue:(double)doubleValue;

Discussion:

Set a global field to be applied to all trackers

setGlobalField:floatValue:

(void)setGlobalField:(NSString *)fieldName floatValue:(float)floatValue;

Discussion:

Set a global field to be applied to all trackers

setGlobalField:integerValue:

(void)setGlobalField:(NSString *)fieldName integerValue:(NSInteger)integerValue;

Discussion:

Set a global field to be applied to all trackers

setGlobalField:stringValue:

(void)setGlobalField:(NSString *)fieldName stringValue:(NSString *)stringValue;

Discussion:

Set a global field to be applied to all trackers

setGlobalUserID:

(void)setGlobalUserID:(NSString *)globalUserID;

Discussion:

Set the global user ID for this tracker

setSessionID:

(void)setSessionID:(NSString *)sessionID;

Discussion:

Set the session ID for this tracker

setSiteID:

(void)setSiteID:(NSString *)siteID;

Discussion:

Set the Site ID for this tracker

sharedTracker

(instancetype)sharedTracker;

Discussion:

Singleton instance of the tracker

submitTimer:

(void)submitTimer:(BTTimer *)timer;

Parameters:

• timer - The BTTimer instance which represents a tracked session.

Discussion:

Submits a timer to Blue triangle for processing