| Package | com.distriqt.extension.facebookapi.appevents |
| Interface | public interface AppEvents extends flash.events.IEventDispatcher |
| Property | Defined By | ||
|---|---|---|---|
| isSupported : Boolean [read-only]
Whether analytics and app events are supported on the current device. | AppEvents | ||
| Method | Defined By | ||
|---|---|---|---|
clearUserID():Boolean
Delete the user ID stored on the device. | AppEvents | ||
flush():Boolean
Manually flushes pending Facebook app events now
| AppEvents | ||
logEvent(event:FacebookAppEvent):Boolean
Sends a logEvent call to Facebook
| AppEvents | ||
logPurchase(event:FacebookAppPurchaseEvent):Boolean
Sends a logPurchase call to Facebook
| AppEvents | ||
setAdvertiserIDCollectionEnabled(enabled:Boolean = true):void
In some cases, you want to delay the collection of the advertiser id, such as to obtain User
consent or fulfill legal obligations, instead of disabling it. | AppEvents | ||
setAutoInitEnabled(enabled:Boolean = true):void | AppEvents | ||
setAutoLogAppEventsEnabled(enabled:Boolean = true):void
In some cases, you want to delay the automatic logging, such as to obtain User
consent or fulfill legal obligations, instead of disabling it. | AppEvents | ||
setFlushBehaviour(mode:String):Boolean
Sets the default behaviour for when the app should flush app events and send them to Facebook
The mode should be one of the values defined in the AnalyticsFlushMode class
the default is MODE_AUTO that will automatically flush events and send when
appropriate. | AppEvents | ||
setUserID(userID:String):Boolean
Assign an ID to a user of your app
| AppEvents | ||
setUserProperties(properties:Object):Boolean
Once you have called setUserID, then you can also create a table with
custom fields for user properties, that you can update with custom values. | AppEvents | ||
| isSupported | property |
isSupported:Boolean [read-only]
Whether analytics and app events are supported on the current device.
public function get isSupported():Boolean| clearUserID | () | method |
public function clearUserID():BooleanDelete the user ID stored on the device.
ReturnsBoolean — true if successful and false otherwise
|
| flush | () | method |
public function flush():Boolean
Manually flushes pending Facebook app events now
ReturnsBoolean |
| logEvent | () | method |
public function logEvent(event:FacebookAppEvent):Boolean
Sends a logEvent call to Facebook
Parameters
event:FacebookAppEvent — - FacebookAppEvent object
|
Boolean |
See also
| logPurchase | () | method |
public function logPurchase(event:FacebookAppPurchaseEvent):Boolean
Sends a logPurchase call to Facebook
Parameters
event:FacebookAppPurchaseEvent — - FacebookAppPurchaseEvent object
|
Boolean |
See also
| setAdvertiserIDCollectionEnabled | () | method |
public function setAdvertiserIDCollectionEnabled(enabled:Boolean = true):voidIn some cases, you want to delay the collection of the advertiser id, such as to obtain User consent or fulfill legal obligations, instead of disabling it. In this case disable the collection of the advertiser id as described in the documentation and then once you have been provided consent call this function to enable (or disable) collection.
Parameters
enabled:Boolean (default = true) |
| setAutoInitEnabled | () | method |
public function setAutoInitEnabled(enabled:Boolean = true):void
Parameters
enabled:Boolean (default = true) |
| setAutoLogAppEventsEnabled | () | method |
public function setAutoLogAppEventsEnabled(enabled:Boolean = true):voidIn some cases, you want to delay the automatic logging, such as to obtain User consent or fulfill legal obligations, instead of disabling it. In this case disable the automatic logging as described in the documentation and then once you have been provided consent call this function to enable (or disable) automatic logging.
Parameters
enabled:Boolean (default = true) |
| setFlushBehaviour | () | method |
public function setFlushBehaviour(mode:String):Boolean
Sets the default behaviour for when the app should flush app events and send them to Facebook
The mode should be one of the values defined in the AnalyticsFlushMode class
the default is MODE_AUTO that will automatically flush events and send when
appropriate.
If you set MODE_EXPLICIT, you must then call the flush
method manually in order for your events to be sent.
Parameters
mode:String (default = NaN) |
Boolean |
See also
| setUserID | () | method |
public function setUserID(userID:String):BooleanAssign an ID to a user of your app
Parameters
userID:String — The ID to use for the current user
|
Boolean — true if successful and false otherwise
|
| setUserProperties | () | method |
public function setUserProperties(properties:Object):Boolean
Once you have called setUserID, then you can also create a table with
custom fields for user properties, that you can update with custom values.
For example, you could have a user property like "Customer Loyalty Status" with
values like "Gold," "Silver," or "Bronze." This would allow you to see and segment
analytics based on these values in Analytics.
Parameters
properties:Object — An object with key-value pairs representing user properties and their values
|
Boolean — true if successful and false otherwise
|