| Package | com.distriqt.extension.facebook.appevents |
| Interface | public interface AppEventsLogger extends flash.events.IEventDispatcher |
| Method | Defined By | ||
|---|---|---|---|
activateApp():void
Notifies the events system that the app has launched and activate and deactivate events should
start being logged automatically. | AppEventsLogger | ||
clearUserID():Boolean
Delete the user ID stored on the device. | AppEventsLogger | ||
flush():Boolean
Manually flushes pending Facebook app events
| AppEventsLogger | ||
getUserID():String
Returns the user id or null if none has been set
| AppEventsLogger | ||
Log an app event with the specified name, supplied value, and set of parameters
| AppEventsLogger | ||
logPurchase(event:AppPurchaseEvent):Boolean
Logs a purchase event with Facebook explicitly, in the specified amount and with the specified
currency. | AppEventsLogger | ||
setFlushBehaviour(mode:String):void
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 FlushBehaviour class
the default is MODE_AUTO that will automatically flush events and send when
appropriate. | AppEventsLogger | ||
setUserID(userID:String):void
Assign an ID to a user of your app
| AppEventsLogger | ||
| activateApp | () | method |
public function activateApp():voidNotifies the events system that the app has launched and activate and deactivate events should start being logged automatically. By default this function is called automatically from initialise() flow. In case 'AutoLogAppEventsEnabled' setting is set to false, it should typically be called from the Event.ACTIVATE event listener method of you application.
| clearUserID | () | method |
public function clearUserID():BooleanDelete the user ID stored on the device.
ReturnsBoolean — true if successful and false if there was an error
|
| flush | () | method |
public function flush():BooleanManually flushes pending Facebook app events
ReturnsBoolean — true if successful and false if there was an error
|
| getUserID | () | method |
public function getUserID():String
Returns the user id or null if none has been set
String — The user id
|
| logEvent | () | method |
public function logEvent(event:AppEvent):BooleanLog an app event with the specified name, supplied value, and set of parameters
Parameters
event:AppEvent — AppEvent object
|
Boolean — true if successful and false if there was an error
|
| logPurchase | () | method |
public function logPurchase(event:AppPurchaseEvent):BooleanLogs a purchase event with Facebook explicitly, in the specified amount and with the specified currency. Additional detail about the purchase can be passed in through the parameters bundle.
Parameters
event:AppPurchaseEvent — AppPurchaseEvent object
|
Boolean — true if successful and false if there was an error
|
| setFlushBehaviour | () | method |
public function setFlushBehaviour(mode:String):void
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 FlushBehaviour 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) |
See also
| setUserID | () | method |
public function setUserID(userID:String):voidAssign an ID to a user of your app
Parameters
userID:String — The ID to use for the current user
|