Packagecom.distriqt.extension.facebook.core
Classpublic final class Facebook
InheritanceFacebook Inheritance flash.events.EventDispatcher

This class represents the Facebook extension.



Public Properties
 PropertyDefined By
  appEventsLogger : AppEventsLogger
[read-only] Access to the App Events Logger functionality
Facebook
  appLinks : AppLinks
[read-only] Access to the App Links functionality.
Facebook
  graphAPI : GraphAPI
[read-only] Access to the Graph API functionality.
Facebook
  implementation : String
[read-only] The implementation currently in use.
Facebook
  instance : Facebook
[static] [read-only] The singleton instance of the Facebook class.
Facebook
  isSupported : Boolean
[static] [read-only] Whether the current device supports the extensions functionality
Facebook
  nativeVersion : String
[read-only] The native version string of the native extension.
Facebook
  service : Facebook
[static] [read-only] The singleton instance of the Facebook class.
Facebook
  version : String
[read-only] The version of this extension.
Facebook
Public Methods
 MethodDefined By
  
Constructor You should not call this directly, but instead use the singleton access
Facebook
  
dispose():void
Disposes the extension and releases any allocated resources.
Facebook
  
Facebook
  
iOS only.
Facebook
  
Gets the Facebook application ID for the current app.
Facebook
  
Gets the Facebook application name for the current app.
Facebook
  
Facebook
  
Gets the flag used by the app events logging
Facebook
  
getSDKVersion():String
Returns the current version of the FacebookSDK used by the extension.
Facebook
  
initialise():Boolean
Initialise the Facebook application.
Facebook
  
Detects whether the device has the native Facebook app installed
Facebook
  
setAdvertiserIDCollectionEnabled(enabled:Boolean):void
Sets the advertiserID collection flag for the application
Facebook
  
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
Facebook
  
setApplicationId(applicationId:String):void
Sets the Facebook application ID for the current app.
Facebook
  
setApplicationName(applicationName:String):void
Sets the Facebook application name for the current app.
Facebook
  
setAutoInitEnabled(enabled:Boolean):void
Sets the auto init SDK flag for the application
Facebook
  
setAutoLogAppEventsEnabled(enabled:Boolean):void
Sets the auto logging events flag for the application app events logging
Facebook
Public Constants
 ConstantDefined By
  EXT_CONTEXT_ID : String = com.distriqt.facebook.Core
[static]
Facebook
  VERSION : String = 17.0.0
[static]
Facebook
Property Detail
appEventsLoggerproperty
appEventsLogger:AppEventsLogger  [read-only]

Access to the App Events Logger functionality


Implementation
    public function get appEventsLogger():AppEventsLogger
appLinksproperty 
appLinks:AppLinks  [read-only]

Access to the App Links functionality.


Implementation
    public function get appLinks():AppLinks
graphAPIproperty 
graphAPI:GraphAPI  [read-only]

Access to the Graph API functionality.


Implementation
    public function get graphAPI():GraphAPI
implementationproperty 
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:


Implementation
    public function get implementation():String
instanceproperty 
instance:Facebook  [read-only]

The singleton instance of the Facebook class.


Implementation
    public static function get instance():Facebook

Throws
Error — If there was a problem creating or accessing the extension, or if the key is invalid
isSupportedproperty 
isSupported:Boolean  [read-only]

Whether the current device supports the extensions functionality


Implementation
    public static function get isSupported():Boolean
nativeVersionproperty 
nativeVersion:String  [read-only]

The native version string of the native extension.


Implementation
    public function get nativeVersion():String
serviceproperty 
service:Facebook  [read-only]

The singleton instance of the Facebook class.


Implementation
    public static function get service():Facebook

Throws
Error — If there was a problem creating or accessing the extension, or if the key is invalid
versionproperty 
version:String  [read-only]

The version of this extension.

This should be of the format, MAJOR.MINOR.BUILD


Implementation
    public function get version():String
Constructor Detail
Facebook()Constructor
public function Facebook()

Constructor You should not call this directly, but instead use the singleton access

Method Detail
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():Boolean

Returns
Boolean — the advertiserID collection flag for the application
getAdvertiserTrackingEnabled()method 
public function getAdvertiserTrackingEnabled():Boolean

iOS only. Will return false on other platforms.

Returns
Boolean — the current state of the tracking enabled setting
getApplicationId()method 
public function getApplicationId():String

Gets the Facebook application ID for the current app. This should only be called after the SDK has been initialized.

Returns
String — the application ID
getApplicationName()method 
public function getApplicationName():String

Gets the Facebook application name for the current app. This should only be called after the SDK has been initialized.

Returns
String — the application name
getAutoInitEnabled()method 
public function getAutoInitEnabled():Boolean

Returns
Boolean — the auto init SDK flag for the application
getAutoLogAppEventsEnabled()method 
public function getAutoLogAppEventsEnabled():Boolean

Gets the flag used by the app events logging

Returns
Boolean — the auto logging events flag for the application
getSDKVersion()method 
public function getSDKVersion():String

Returns the current version of the FacebookSDK used by the extension.

Returns
String — 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 );

Returns
Booleantrue on success
isFacebookAppInstalled()method 
public function isFacebookAppInstalled():Boolean

Detects whether the device has the native Facebook app installed

Returns
Boolean — Boolean true or false
setAdvertiserIDCollectionEnabled()method 
public function setAdvertiserIDCollectionEnabled(enabled:Boolean):void

Sets the advertiserID collection flag for the application

Parameters

enabled:Boolean — true or false

setAdvertiserTrackingEnabled()method 
public function 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

Parameters

enabled:Boolean — true or false

setApplicationId()method 
public function setApplicationId(applicationId:String):void

Sets the Facebook application ID for the current app.

Parameters

applicationId:String — the application ID

setApplicationName()method 
public function setApplicationName(applicationName:String):void

Sets the Facebook application name for the current app.

Parameters

applicationName:String — the application name

setAutoInitEnabled()method 
public function setAutoInitEnabled(enabled:Boolean):void

Sets 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):void

Sets 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

Constant Detail
EXT_CONTEXT_IDConstant
public static const EXT_CONTEXT_ID:String = com.distriqt.facebook.Core

VERSIONConstant 
public static const VERSION:String = 17.0.0