| Package | com.distriqt.extension.facebook.login |
| Class | public final class FacebookLogin |
| Inheritance | FacebookLogin flash.events.EventDispatcher |
This class represents the FacebookLogin extension.
| Property | Defined By | ||
|---|---|---|---|
| implementation : String [read-only]
The implementation currently in use. | FacebookLogin | ||
| instance : FacebookLogin [static] [read-only]
The singleton instance of the FacebookLogin class. | FacebookLogin | ||
| isSupported : Boolean [static] [read-only]
Whether the current device supports the extensions functionality
| FacebookLogin | ||
| nativeVersion : String [read-only]
The native version string of the native extension. | FacebookLogin | ||
| service : FacebookLogin [static] [read-only]
The singleton instance of the FacebookLogin class. | FacebookLogin | ||
| version : String [read-only]
The version of this extension. | FacebookLogin | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor
You should not call this directly, but instead use the singleton access
| FacebookLogin | ||
dispose():void
Disposes the extension and releases any allocated resources. | FacebookLogin | ||
Retrieves the current access token, if available
| FacebookLogin | ||
The current authentication token that represents the currently logged in user
and can be used by a client to verify an authentication attempt. | FacebookLogin | ||
Retrieves the current user profile information, if available
| FacebookLogin | ||
isLoggedIn():Boolean
Checks if a user is currently logged in. | FacebookLogin | ||
logInWithConfiguration(configuration:LoginConfiguration):void
Logs the user in or authorizes additional permissions
| FacebookLogin | ||
logInWithReadPermissions(permissions:Array):void
Logs the user in or authorizes additional permissions. | FacebookLogin | ||
logout():void | FacebookLogin | ||
| Constant | Defined By | ||
|---|---|---|---|
| EXT_CONTEXT_ID : String = com.distriqt.facebook.Login [static] | FacebookLogin | ||
| VERSION : String = 18.1.0 [static] | FacebookLogin | ||
| 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:FacebookLogin [read-only] The singleton instance of the FacebookLogin class.
public static function get instance():FacebookLoginError — 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:FacebookLogin [read-only] The singleton instance of the FacebookLogin class.
public static function get service():FacebookLoginError — 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| FacebookLogin | () | Constructor |
public function FacebookLogin()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.
| getAccessToken | () | method |
public function getAccessToken():AccessTokenRetrieves the current access token, if available
ReturnsAccessToken — The access token or null if not available
|
| getAuthenticationToken | () | method |
public function getAuthenticationToken():AuthenticationTokenThe current authentication token that represents the currently logged in user and can be used by a client to verify an authentication attempt.
ReturnsAuthenticationToken — Current authentication token or null if not available
|
| getProfile | () | method |
public function getProfile():ProfileRetrieves the current user profile information, if available
ReturnsProfile — The current user profile or null if not available
|
| isLoggedIn | () | method |
public function isLoggedIn():BooleanChecks if a user is currently logged in.
ReturnsBoolean — true if a user is logged in and false if not
|
| logInWithConfiguration | () | method |
public function logInWithConfiguration(configuration:LoginConfiguration):voidLogs the user in or authorizes additional permissions
Parameters
configuration:LoginConfiguration — the login configuration to use
|
| logInWithReadPermissions | () | method |
public function logInWithReadPermissions(permissions:Array):voidLogs the user in or authorizes additional permissions.
Parameters
permissions:Array |
| logout | () | method |
public function logout():void
| EXT_CONTEXT_ID | Constant |
public static const EXT_CONTEXT_ID:String = com.distriqt.facebook.Login| VERSION | Constant |
public static const VERSION:String = 18.1.0