Packagecom.distriqt.extension.firebase.analytics
Interfacepublic interface FirebaseAnalytics extends flash.events.IEventDispatcher



Public Methods
 MethodDefined By
  
Initiate an on-device conversion event measurement with the given email address as the user identifier.
FirebaseAnalytics
  
Initiate an on-device conversion event measurement with the given hashed email address as the user identifier.
FirebaseAnalytics
  
Initiate an on-device conversion event measurement with the given hashed phone number as the user identifier.
FirebaseAnalytics
  
Initiate an on-device conversion event measurement with the given phone number as the user identifier.
FirebaseAnalytics
  
logEvent(event:EventObject):Boolean
Logs an app event
FirebaseAnalytics
  
setAnalyticsCollectionEnabled(enabled:Boolean):Boolean
Sets whether analytics collection is enabled for this app on this device.
FirebaseAnalytics
  
setCurrentScreen(screenName:String, screenClass:String):Boolean
Deprecated: Use logEvent with name EventObject.SCREEN_VIEW
Sets the current screen name, which specifies the current visual context in your app.
FirebaseAnalytics
  
setMinimumSessionDuration(milliseconds:int):Boolean
Deprecated: This function does nothing
Sets the minimum engagement time required before starting a session.
FirebaseAnalytics
  
setSessionTimeoutDuration(milliseconds:int):Boolean
Sets the duration of inactivity that terminates the current session.
FirebaseAnalytics
  
setUserID(userID:String):Boolean
Sets the user ID property.
FirebaseAnalytics
  
setUserProperty(name:String, value:String):Boolean
Sets a user property to a given value.
FirebaseAnalytics
Method Detail
initiateOnDeviceConversionMeasurementWithEmailAddress()method
public function initiateOnDeviceConversionMeasurementWithEmailAddress(email:String):Boolean

Initiate an on-device conversion event measurement with the given email address as the user identifier.

Parameters

email:String — Email address

Returns
Booleantrue if successful and false otherwise (not supported)
initiateOnDeviceConversionMeasurementWithHashedEmailAddress()method 
public function initiateOnDeviceConversionMeasurementWithHashedEmailAddress(email:ByteArray):Boolean

Initiate an on-device conversion event measurement with the given hashed email address as the user identifier.

Parameters

email:ByteArray — Hashed email address data

Returns
Booleantrue if successful and false otherwise (not supported)
initiateOnDeviceConversionMeasurementWithHashedPhoneNumber()method 
public function initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(phoneNumber:ByteArray):Boolean

Initiate an on-device conversion event measurement with the given hashed phone number as the user identifier.

Parameters

phoneNumber:ByteArray — Hashed phone number data

Returns
Booleantrue if successful and false otherwise (not supported)
initiateOnDeviceConversionMeasurementWithPhoneNumber()method 
public function initiateOnDeviceConversionMeasurementWithPhoneNumber(phoneNumber:String):Boolean

Initiate an on-device conversion event measurement with the given phone number as the user identifier.

Parameters

phoneNumber:String — Phone number

Returns
Booleantrue if successful and false otherwise (not supported)
logEvent()method 
public function logEvent(event:EventObject):Boolean

Logs an app event

Parameters

event:EventObject — The EventObject to log

Returns
Booleantrue if successful and false otherwise
setAnalyticsCollectionEnabled()method 
public function setAnalyticsCollectionEnabled(enabled:Boolean):Boolean

Sets whether analytics collection is enabled for this app on this device. This setting is persisted across app sessions. By default it is enabled.

Parameters

enabled:Boolean — Whether analytics collection is enabled for this app on this device

Returns
Booleantrue if successful and false otherwise
setCurrentScreen()method 
public function setCurrentScreen(screenName:String, screenClass:String):Boolean
Deprecated: Use logEvent with name EventObject.SCREEN_VIEW

Sets the current screen name, which specifies the current visual context in your app. This helps identify the areas in your app where users spend their time and how they interact with your app. This functionality is now deprecated. You should log an event using the name EventObject.SCREEN_VIEW and the following params:

var event:EventObject = new EventObject();
event.name = EventObject.SCREEN_VIEW;
event.params[ Params.SCREEN_NAME ] = screenName;
Firebase.service.analytics.logEvent( event );
         

Parameters

screenName:String — The name of the current screen. Should contain 1 to 100 characters.
 
screenClass:String — The name of the screen class. Should contain 1 to 100 characters.

Returns
Booleantrue if successful and false otherwise
setMinimumSessionDuration()method 
public function setMinimumSessionDuration(milliseconds:int):Boolean
Deprecated: This function does nothing

Sets the minimum engagement time required before starting a session. The default value is 10000 (10 seconds). Deprecated. This will do nothing now.

Parameters

milliseconds:int — The minimum engagement time required to start a new session.

Returns
Booleantrue if successful and false otherwise
setSessionTimeoutDuration()method 
public function setSessionTimeoutDuration(milliseconds:int):Boolean

Sets the duration of inactivity that terminates the current session. The default value is 1800000 (30 minutes).

Parameters

milliseconds:int — Session timeout duration in milliseconds

Returns
Booleantrue if successful and false otherwise
setUserID()method 
public function setUserID(userID:String):Boolean

Sets the user ID property. This feature must be used in accordance with Google's Privacy Policy.

Parameters

userID:String — The user ID to ascribe to the user of this app on this device, which must be non-empty and no more than 36 characters long.

Returns
Booleantrue if successful and false otherwise
setUserProperty()method 
public function setUserProperty(name:String, value:String):Boolean

Sets a user property to a given value. Up to 25 user property names are supported. Once set, user property values persist throughout the app lifecycle and across sessions.

Parameters

name:String — The name of the user property to set. Should contain 1 to 24 alphanumeric characters or underscores and must start with an alphabetic character. The "firebase_" prefix is reserved and should not be used for user property names.
 
value:String — The value of the user property. Values can be up to 36 characters long.

Returns
Booleantrue if successful and false otherwise