| Package | com.distriqt.extension.flurry |
| Interface | public interface FlurryAnalytics |
| Property | Defined By | ||
|---|---|---|---|
| userProperties : UserProperties [read-only]
Access to the user properties functionality
| FlurryAnalytics | ||
| Method | Defined By | ||
|---|---|---|---|
endSession():void
End a Flurry session
| FlurryAnalytics | ||
endTimedEvent(event:String, parameters:Object = null):void
Ends a timed event specified by eventName and optionally updates parameters with parameters
This method ends an existing timed event. | FlurryAnalytics | ||
getFlurryAgentVersion():String
Retrieves the Flurry Agent Build Version
| FlurryAnalytics | ||
initialise(apiKey:String, config:FlurryAnalyticsConfig = null):void
Initialise the Flurry analytics SDK with the specific API Key. | FlurryAnalytics | ||
initialiseWithKeys(iosAPIKey:String, apiKeyAndroid:String, config:FlurryAnalyticsConfig = null):void
Initialise the Flurry analytics SDK with the platform API keys. | FlurryAnalytics | ||
logError(name:String, message:String):void
Records an app error. | FlurryAnalytics | ||
logEvent(event:String, parameters:Object = null, isTimed:Boolean = false):void
Records a custom event specified by event
| FlurryAnalytics | ||
logPayment(data:PaymentData, parameters:Object = null):void
Used to pass Flurry explicit details about a payment
| FlurryAnalytics | ||
logStandardEvent(event:String, parameters:FlurryEventParams = null):int
Records a standard event. | FlurryAnalytics | ||
setAge(age:int):void
Set your user's age in years
| FlurryAnalytics | ||
setAppVersion(version:String):void
Explicitly specifies the App Version that Flurry will use to group Analytics data
| FlurryAnalytics | ||
setGender(gender:String):void
Set your user's gender. | FlurryAnalytics | ||
setReportLocation(enabled:Boolean):void
Flurry will track where your app is being used. | FlurryAnalytics | ||
setUserID(userId:String):void
Assign a unique id for a user in your app. | FlurryAnalytics | ||
startSession():void
Start a Flurry session
| FlurryAnalytics | ||
| userProperties | property |
userProperties:UserProperties [read-only] Access to the user properties functionality
public function get userProperties():UserProperties| endSession | () | method |
public function endSession():voidEnd a Flurry session
| endTimedEvent | () | method |
public function endTimedEvent(event:String, parameters:Object = null):void
Ends a timed event specified by eventName and optionally updates parameters with parameters
This method ends an existing timed event.
If parameters are provided, this will overwrite existing parameters with the same name.
Parameters
event:String — Name of the event
| |
parameters:Object (default = null) |
| getFlurryAgentVersion | () | method |
public function getFlurryAgentVersion():StringRetrieves the Flurry Agent Build Version
ReturnsString — The Flurry Agent Build Version String
|
| initialise | () | method |
public function initialise(apiKey:String, config:FlurryAnalyticsConfig = null):voidInitialise the Flurry analytics SDK with the specific API Key. Use this function if you manage the different platform API keys and set a custom configuration.
Parameters
apiKey:String — The API Key to use for analytic sessions
| |
config:FlurryAnalyticsConfig (default = null) |
| initialiseWithKeys | () | method |
public function initialiseWithKeys(iosAPIKey:String, apiKeyAndroid:String, config:FlurryAnalyticsConfig = null):void
Initialise the Flurry analytics SDK with the platform API keys. This function will use the key appropriate for the platform of the device.
Parameters
iosAPIKey:String — API key to use on iOS devices
| |
apiKeyAndroid:String — API key to use on Android devices
| |
config:FlurryAnalyticsConfig (default = null) |
| logError | () | method |
public function logError(name:String, message:String):voidRecords an app error. This method captures an error for reporting to Flurry
Parameters
name:String — Name of the error
| |
message:String — The message to associate with the error
|
| logEvent | () | method |
public function logEvent(event:String, parameters:Object = null, isTimed:Boolean = false):void
Records a custom event specified by event
Parameters
event:String — Name of the event.
For maximum effectiveness, we recommend using
a naming scheme that can be easily understood
by non-technical people in your business domain.
| |
parameters:Object (default = null) | |
isTimed:Boolean (default = false) |
| logPayment | () | method |
public function logPayment(data:PaymentData, parameters:Object = null):voidUsed to pass Flurry explicit details about a payment
Parameters
data:PaymentData — The payment data to log
| |
parameters:Object (default = null) |
| logStandardEvent | () | method |
public function logStandardEvent(event:String, parameters:FlurryEventParams = null):intRecords a standard event.
Parameters
event:String — One of the FlurryEvent defined constants
| |
parameters:FlurryEventParams (default = null)FlurryEventParams class, specifying the parameters for this event
|
int — Status of the event logging. One of the status codes defined in the FlurryEventRecordStatus class.
|
See also
| setAge | () | method |
public function setAge(age:int):voidSet your user's age in years
Parameters
age:int — Reported age of user
|
| setAppVersion | () | method |
public function setAppVersion(version:String):voidExplicitly specifies the App Version that Flurry will use to group Analytics data
Parameters
version:String — The custom version name
|
| setGender | () | method |
public function setGender(gender:String):void
Set your user's gender.
Use this method to capture the gender of your user.
Only use this method if you collect this information explictly
from your user (i.e. - there is no need to set a default value).
Allowable values are Gender.MALE or Gender.FEMALE
Parameters
gender:String — Reported gender of user
|
| setReportLocation | () | method |
public function setReportLocation(enabled:Boolean):voidFlurry will track where your app is being used. Flurry uses cached value (to avoid excessive battery usage) when location reporting is enabled. Without location permission, Flurry will use the IP address of the user’s device and report this information at the country level.
Parameters
enabled:Boolean — false to disable automatic collection of user location even if available
|
| setUserID | () | method |
public function setUserID(userId:String):voidAssign a unique id for a user in your app.
Parameters
userId:String — The app id for a user
|
| startSession | () | method |
public function startSession():voidStart a Flurry session