Package | com.myflashlab.air.extensions.adobeMobile |
Class | public class Analytics |
Inheritance | Analytics flash.events.EventDispatcher |
Property | Defined By | ||
---|---|---|---|
trackingIdentifier : String [read-only]
Retrieves the analytics tracking identifier. | Analytics |
Method | Defined By | ||
---|---|---|---|
clearQueue():void
Clears any hits out of the tracking queue and removes them from the database
| Analytics | ||
getQueueSize():Number
Retrieves the number of hits currently in the tracking queue
| Analytics | ||
sendQueuedHits():void
Force library to send all queued hits regardless of current batch options
| Analytics | ||
trackAction($action:String, $contextData:ContextData = null, $fromBackground:Boolean = false):void
Tracks an action with ContextData. | Analytics | ||
trackLifetimeValueIncrease($amount:Number, $contextData:ContextData = null):void
Tracks an increase in a user's lifetime value. | Analytics | ||
trackLocation($latitude:Number, $longitude:Number, $contextData:ContextData = null):void
Tracks a location with ContextData. | Analytics | ||
trackState($state:String, $contextData:ContextData = null):void
Tracks a state with context data. | Analytics | ||
trackTimedActionEnd($action:String, $contextData:ContextData = null, $sendHit:Boolean = true):void
Tracks the end of a timed event. | Analytics | ||
trackTimedActionStart($action:String, $contextData:ContextData = null):void
Tracks the start of a timed event. | Analytics | ||
trackTimedActionUpdate($action:String, $contextData:ContextData = null):void
Tracks the start of a timed event. | Analytics |
trackingIdentifier | property |
trackingIdentifier:String
[read-only] Retrieves the analytics tracking identifier.
public function get trackingIdentifier():String
clearQueue | () | method |
public function clearQueue():void
Clears any hits out of the tracking queue and removes them from the database
getQueueSize | () | method |
public function getQueueSize():Number
Retrieves the number of hits currently in the tracking queue
ReturnsNumber — indicating the size of the queue
|
sendQueuedHits | () | method |
public function sendQueuedHits():void
Force library to send all queued hits regardless of current batch options
trackAction | () | method |
public function trackAction($action:String, $contextData:ContextData = null, $fromBackground:Boolean = false):void
Tracks an action with ContextData. This method does not increment page views.
Parameters
$action:String — the action value to be tracked
| |
$contextData:ContextData (default = null ) — ContextData to be tracked
| |
$fromBackground:Boolean (default = false ) — no effect on Android side. on iOS though, it is intended to be called while your
app is in the background (it will not cause lifecycle data to send if the session timeout has been exceeded)
|
trackLifetimeValueIncrease | () | method |
public function trackLifetimeValueIncrease($amount:Number, $contextData:ContextData = null):void
Tracks an increase in a user's lifetime value. This method does not increment page views.
Parameters
$amount:Number — a positive Number detailing the amount to increase lifetime value by.
| |
$contextData:ContextData (default = null ) — ContextData to be tracked
|
trackLocation | () | method |
public function trackLocation($latitude:Number, $longitude:Number, $contextData:ContextData = null):void
Tracks a location with ContextData. This method does not increment page views.
Parameters
$latitude:Number | |
$longitude:Number | |
$contextData:ContextData (default = null ) — ContextData to be tracked
|
trackState | () | method |
public function trackState($state:String, $contextData:ContextData = null):void
Tracks a state with context data. This method increments page views.
Parameters
$state:String — The state value to be tracked
| |
$contextData:ContextData (default = null ) — ContextData to be tracked
|
trackTimedActionEnd | () | method |
public function trackTimedActionEnd($action:String, $contextData:ContextData = null, $sendHit:Boolean = true):void
Tracks the end of a timed event. This method will send a tracking hit if the $sendHit
parameter
is true.
Parameters
$action:String — String pointer that denotes the action name to finish tracking.
| |
$contextData:ContextData (default = null ) — optional ContextData containing context data
| |
$sendHit:Boolean (default = true )
|
trackTimedActionStart | () | method |
public function trackTimedActionStart($action:String, $contextData:ContextData = null):void
Tracks the start of a timed event. This method does not send a tracking hit. If an action with the same name already exists it will be deleted and a new one will replace it.
Parameters
$action:String — String value that denotes the action name to track.
| |
$contextData:ContextData (default = null ) — optional ContextData containing context data to track with this timed action.
|
trackTimedActionUpdate | () | method |
public function trackTimedActionUpdate($action:String, $contextData:ContextData = null):void
Tracks the start of a timed event. This method does not send a tracking hit. When the timed event is updated, the contents of the parameter data will overwrite existing context data keys and append new ones.
Parameters
$action:String — String value that denotes the action name to track.
| |
$contextData:ContextData (default = null ) — optional ContextData containing context data to track with this timed action.
|