| Package | com.distriqt.extension.facebook.core |
| Class | public final class Facebook |
| Inheritance | Facebook  flash.events.EventDispatcher |
This class represents the Facebook extension.
| Property | Defined By | ||
|---|---|---|---|
| appEventsLogger : AppEventsLogger [read-only]
Access to the App Events Logger functionality
| |||
| appLinks : AppLinks [read-only]
Access to the App Links functionality. | |||
| graphAPI : GraphAPI [read-only]
Access to the Graph API functionality. | |||
| implementation : String [read-only]
The implementation currently in use. | |||
| instance : Facebook [static] [read-only]
The singleton instance of the Facebook class. | |||
| isSupported : Boolean [static] [read-only]
Whether the current device supports the extensions functionality
| |||
| nativeVersion : String [read-only]
The native version string of the native extension. | |||
| service : Facebook [static] [read-only]
The singleton instance of the Facebook class. | |||
| version : String [read-only]
The version of this extension. | |||
| Method | Defined By | ||
|---|---|---|---|
Facebook()
Constructor
You should not call this directly, but instead use the singleton access
| |||
dispose():void
Disposes the extension and releases any allocated resources. | |||
getAdvertiserIDCollectionEnabled():Boolean | |||
getAdvertiserTrackingEnabled():Boolean
iOS only. | |||
getApplicationId():String
Gets the Facebook application ID for the current app. | |||
getApplicationName():String
Gets the Facebook application name for the current app. | |||
getAutoInitEnabled():Boolean | |||
getAutoLogAppEventsEnabled():Boolean
Gets the flag used by the app events logging
| |||
getSDKVersion():String
Returns the current version of the FacebookSDK used by the extension. | |||
initialise():Boolean
Initialise the Facebook application. | |||
isFacebookAppInstalled():Boolean
Detects whether the device has the native Facebook app installed
| |||
setAdvertiserIDCollectionEnabled(enabled:Boolean):void
Sets the advertiserID collection flag for the application
| |||
setAdvertiserTrackingEnabled(enabled:Boolean):void
Sets the advertiser tracking enabled flag for the application
iOS only
Reference: https://developers.facebook.com/docs/app-events/guides/advertising-tracking-enabled
| |||
setApplicationId(applicationId:String):void
Sets the Facebook application ID for the current app. | |||
setApplicationName(applicationName:String):void
Sets the Facebook application name for the current app. | |||
setAutoInitEnabled(enabled:Boolean):void
Sets the auto init SDK flag for the application
| |||
setAutoLogAppEventsEnabled(enabled:Boolean):void
Sets the auto logging events flag for the application app events logging
| |||
| Constant | Defined By | ||
|---|---|---|---|
| EXT_CONTEXT_ID : String = com.distriqt.facebook.Core [static] | |||
| VERSION : String = 17.0.1 [static] | |||
| appEventsLogger | property |
appEventsLogger:AppEventsLogger [read-only] Access to the App Events Logger functionality
public function get appEventsLogger():AppEventsLogger| appLinks | property |
appLinks:AppLinks [read-only] Access to the App Links functionality.
public function get appLinks():AppLinks| graphAPI | property |
graphAPI:GraphAPI [read-only] Access to the Graph API functionality.
public function get graphAPI():GraphAPI| implementation | property |
implementation:String [read-only]
The implementation currently in use. This should be one of the following depending on the platform in use and the functionality supported by this extension:
AndroidiOSdefaultunknown public function get implementation():String| instance | property |
instance:Facebook [read-only] The singleton instance of the Facebook class.
public static function get instance():FacebookError — If there was a problem creating or accessing the extension, or if the key is invalid
|
| isSupported | property |
isSupported:Boolean [read-only] Whether the current device supports the extensions functionality
public static function get isSupported():Boolean| nativeVersion | property |
nativeVersion:String [read-only]
The native version string of the native extension.
public function get nativeVersion():String| service | property |
service:Facebook [read-only] The singleton instance of the Facebook class.
public static function get service():FacebookError — If there was a problem creating or accessing the extension, or if the key is invalid
|
| version | property |
version:String [read-only]
The version of this extension.
This should be of the format, MAJOR.MINOR.BUILD
public function get version():String| () | Constructor |
public function Facebook()Constructor You should not call this directly, but instead use the singleton access
| dispose | () | method |
public function dispose():void
Disposes the extension and releases any allocated resources. Once this function
has been called, a call to init is neccesary again before any of the
extensions functionality will work.
| getAdvertiserIDCollectionEnabled | () | method |
public function getAdvertiserIDCollectionEnabled():BooleanReturns
Boolean — the advertiserID collection flag for the application
|
| getAdvertiserTrackingEnabled | () | method |
public function getAdvertiserTrackingEnabled():Boolean
iOS only. Will return false on other platforms.
Boolean — the current state of the tracking enabled setting
|
| getApplicationId | () | method |
public function getApplicationId():StringGets the Facebook application ID for the current app. This should only be called after the SDK has been initialized.
ReturnsString — the application ID
|
| getApplicationName | () | method |
public function getApplicationName():StringGets the Facebook application name for the current app. This should only be called after the SDK has been initialized.
ReturnsString — the application name
|
| getAutoInitEnabled | () | method |
public function getAutoInitEnabled():BooleanReturns
Boolean — the auto init SDK flag for the application
|
| getAutoLogAppEventsEnabled | () | method |
public function getAutoLogAppEventsEnabled():BooleanGets the flag used by the app events logging
ReturnsBoolean — the auto logging events flag for the application
|
| getSDKVersion | () | method |
public function getSDKVersion():StringReturns the current version of the FacebookSDK used by the extension.
ReturnsString — String the Facebook SDK version
|
| initialise | () | method |
public function initialise():Boolean
Initialise the Facebook application.
If you have disabled automatic initialisation you must call this after you have
gathered your required permissions and called setAutoInitEnabled( true );
Boolean — true on success
|
| isFacebookAppInstalled | () | method |
public function isFacebookAppInstalled():BooleanDetects whether the device has the native Facebook app installed
ReturnsBoolean — Boolean true or false
|
| setAdvertiserIDCollectionEnabled | () | method |
public function setAdvertiserIDCollectionEnabled(enabled:Boolean):voidSets the advertiserID collection flag for the application
Parameters
enabled:Boolean — true or false
|
| setAdvertiserTrackingEnabled | () | method |
public function setAdvertiserTrackingEnabled(enabled:Boolean):voidSets the advertiser tracking enabled flag for the application iOS only Reference: https://developers.facebook.com/docs/app-events/guides/advertising-tracking-enabled
Parameters
enabled:Boolean — true or false
|
| setApplicationId | () | method |
public function setApplicationId(applicationId:String):voidSets the Facebook application ID for the current app.
Parameters
applicationId:String — the application ID
|
| setApplicationName | () | method |
public function setApplicationName(applicationName:String):voidSets the Facebook application name for the current app.
Parameters
applicationName:String — the application name
|
| setAutoInitEnabled | () | method |
public function setAutoInitEnabled(enabled:Boolean):voidSets the auto init SDK flag for the application
Parameters
enabled:Boolean — true or false. When flag is false, SDK is not fully initialized
|
| setAutoLogAppEventsEnabled | () | method |
public function setAutoLogAppEventsEnabled(enabled:Boolean):voidSets the auto logging events flag for the application app events logging
Parameters
enabled:Boolean — true or false. When flag is false, events will not be logged
|
| EXT_CONTEXT_ID | Constant |
public static const EXT_CONTEXT_ID:String = com.distriqt.facebook.Core| VERSION | Constant |
public static const VERSION:String = 17.0.1