Packagecom.google.analytics.data
Classpublic class X10

Google Analytics Tracker Code (GATC)'s extensible data component. This class encapsulates all logic for setting and clearing extensible data and generating the resultant URL parameter.



Public Methods
 MethodDefined by
  
X10()
Creates a new X10 instance.
X10
  
clearKey(projectId:Number):void
Wrapper for clearing all X10 string keys for a given project ID.
X10
  
clearValue(projectId:Number):void
Wrapper for clearing all X10 integer values for a given project ID.
X10
  
getKey(projectId:Number, num:Number):String
Wrapper for getting an X10 string key.
X10
  
getValue(projectId:Number, num:Number):*
Wrapper for getting an X10 integer value.
X10
  
hasData():Boolean
Indicates if the X10 object has data.
X10
  
hasProject(projectId:Number):Boolean
Checking whether a project exists in the current data state.
X10
  
renderMergedUrlString(extObject:X10 = null):String
Render the merged url String representation of the X10 passed-in object.
X10
  
renderUrlString():String
Generates the URL parameter string for the current internal extensible data state.
X10
  
setKey(projectId:Number, num:Number, value:String):Boolean
Wrapper for setting an X10 string key.
X10
  
setValue(projectId:Number, num:Number, value:Number):Boolean
Wrapper for setting an X10 integer value.
X10
Constructor detail
X10()constructor
public function X10()

Creates a new X10 instance.

Method detail
clearKey()method
public function clearKey(projectId:Number):void

Wrapper for clearing all X10 string keys for a given project ID.

Parameters
projectId:Number — The project ID for which to clear all keys.
clearValue()method 
public function clearValue(projectId:Number):void

Wrapper for clearing all X10 integer values for a given project ID.

Parameters
projectId:Number — The project ID for which to clear all values.
getKey()method 
public function getKey(projectId:Number, num:Number):String

Wrapper for getting an X10 string key.

Parameters
projectId:Number — The project ID for which to get a value.
 
num:Number — The numeric index for which to get a value.

Returns
String — The requested key, null if not found.
getValue()method 
public function getValue(projectId:Number, num:Number):*

Wrapper for getting an X10 integer value.

Parameters
projectId:Number — The project ID for which to get a value.
 
num:Number — The numeric index for which to get a value.

Returns
* — The requested value in number form, null if not found.
hasData()method 
public function hasData():Boolean

Indicates if the X10 object has data.

Returns
Boolean
hasProject()method 
public function hasProject(projectId:Number):Boolean

Checking whether a project exists in the current data state.

Parameters
projectId:Number — The identifier for the project.

Returns
Boolean — whether this X10 module contains the project at the designated project ID.
renderMergedUrlString()method 
public function renderMergedUrlString(extObject:X10 = null):String

Render the merged url String representation of the X10 passed-in object.

Parameters
extObject:X10 (default = null)

Returns
String — The merged url String representation of the X10 passed-in object.
renderUrlString()method 
public function renderUrlString():String

Generates the URL parameter string for the current internal extensible data state.

Returns
String — Encoded extensible data string.
setKey()method 
public function setKey(projectId:Number, num:Number, value:String):Boolean

Wrapper for setting an X10 string key.

Parameters
projectId:Number — The project ID for which to set a value.
 
num:Number — The numeric index for which to set a value.
 
value:String — The value to be set into the specified indices.

Returns
Boolean — Whether the key was successfully set.
setValue()method 
public function setValue(projectId:Number, num:Number, value:Number):Boolean

Wrapper for setting an X10 integer value.

Parameters
projectId:Number — The project ID for which to set a value.
 
num:Number — The numeric index for which to set a value.
 
value:Number — The value to be set into the specified indices.

Returns
Boolean — whether the value was successfully set.