| Package | com.jeffdePascale.fosfr.tracking |
| Class | public class Tracking |
| Inheritance | Tracking  flash.events.EventDispatcher |
Tracking class handles queueing and processing of tracking tags within a Fosfr project. Any number of tracking methods can be specified in the configuration XML file (or within the code by passing a properly formatted XMLList to the initialize() method), and each tag that is is passed via the track() method will pass through each method specified, staggered over time by the value specified in the delay property. Additional methods may be created by basing a new class off of the TrackMethodPrototype class in tracking.methods.prototype.
See also
| Property | Defined by | ||
|---|---|---|---|
| delay : uint
Specifies the time in milliseconds to delay between tracking calls.
| Tracking | ||
| enabled : Boolean
A Boolean value specifying whether tracking tags should be accepted into the tracking queue and processed.
| Tracking | ||
| runningMethod : String [read-only]
The name of the current tracking method that is processing the tracking tag.
| Tracking | ||
| trackAllMethods : Boolean
A boolean value specifying whether to send tracking calls to all the methods instantiated.
| Tracking | ||
| Method | Defined by | ||
|---|---|---|---|
|
Tracking(_fosfr:FosfrBaseClass, _enabled:Boolean = true)
Creates an instance of the tracking class.
| Tracking | ||
|
initialize(methodStringsList:XMLList):void
Populates the Tracking class with an XMLList containing the values and parameters for the tracking methods specified within.
| Tracking | ||
|
track(trackTag:String, forceMethod:String = null, ... args):void
Adds a new value to be tracked to the Tracking class.
| Tracking | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Dispatched when all the tracking tags remaining in the Tracking queue have been processed. | Tracking | |||
Dispatched when the track method of the chose tracking method(s) is called. | Tracking | |||
| delay | property |
public var delay:uintSpecifies the time in milliseconds to delay between tracking calls. This delay prevents URL requests sent by the tracking methods from interfering with each other.
The default value is 500.
| enabled | property |
public var enabled:BooleanA Boolean value specifying whether tracking tags should be accepted into the tracking queue and processed.
The default value is true.
| runningMethod | property |
runningMethod:String [read-only]
The name of the current tracking method that is processing the tracking tag. This value changes at intervals defined by the delay property.
public function get runningMethod():String
| trackAllMethods | property |
public var trackAllMethods:Boolean
A boolean value specifying whether to send tracking calls to all the methods instantiated. If set to false, tracking calls will only fire to the default tracking method, the first one specified. Tracking via additional methods is achieved via the second parameter of the track method, forceMethod.
The default value is true.
| Tracking | () | constructor |
public function Tracking(_fosfr:FosfrBaseClass, _enabled:Boolean = true)Creates an instance of the tracking class.
Parameters_fosfr:FosfrBaseClass — An instance of Fosfr.
|
|
_enabled:Boolean (default = true) |
See also
| initialize | () | method |
public function initialize(methodStringsList:XMLList):voidPopulates the Tracking class with an XMLList containing the values and parameters for the tracking methods specified within.
ParametersmethodStringsList:XMLList — An XMLList object containing the names of the methods to instantiate for tracking and the parameters for that method, specified as attributes of the method's node.
|
| track | () | method |
public function track(trackTag:String, forceMethod:String = null, ... args):voidAdds a new value to be tracked to the Tracking class. If the queue is not currently running, this will restart the cue and begin passing values to the method(s) specified in the Tracking instance.
ParameterstrackTag:String — The stirng value to be passed to the trackng method(s).
|
|
forceMethod:String (default = null) |
|
... args |
| complete | event |
com.jeffdePascale.fosfr.core.tracking.TrackingEvent
Dispatched when all the tracking tags remaining in the Tracking queue have been processed.
| track | event |
com.jeffdePascale.fosfr.core.tracking.TrackingEvent
Dispatched when the track method of the chose tracking method(s) is called.