Package | com.distriqt.extension.facebookapi.events |
Class | public class FacebookAPISessionEvent |
Inheritance | FacebookAPISessionEvent ![]() |
This class represents the session related events dispatched by the FacebookAPI ANE.
These events mainly are session information events containing information about the current user and their logged in state, including access tokens and profile data.
Property | Defined By | ||
---|---|---|---|
accessToken : AccessToken = null
The current user access token or null if one is not available
| FacebookAPISessionEvent | ||
errorCode : int = -1
If an error occurred this will contain the code of that error
| FacebookAPISessionEvent | ||
errorMessage : String = null
If an error occurred this will contain a description of the error
| FacebookAPISessionEvent | ||
profile : Profile = null
The current user profile, includes information about the user's name etc
or null if profile information is not available
| FacebookAPISessionEvent |
Method | Defined By | ||
---|---|---|---|
FacebookAPISessionEvent(type:String, accessToken:AccessToken = null, profile:Profile = null, errorCode:int = -1, errorMessage:String = null, bubbles:Boolean = false, cancelable:Boolean = false)
Constructor
| FacebookAPISessionEvent | ||
clone():Event [override] | FacebookAPISessionEvent |
Constant | Defined By | ||
---|---|---|---|
REQUEST_PERMISSIONS_CANCELLED : String = facebookapi:permissions:request:cancelled [static]
Dispatched when the user cancelled the request for additional permissions
| FacebookAPISessionEvent | ||
REQUEST_PERMISSIONS_COMPLETED : String = facebookapi:permissions:request:completed [static]
Dispatched when a request for additional permissions was successful
| FacebookAPISessionEvent | ||
REQUEST_PERMISSIONS_ERROR : String = facebookapi:permissions:request:error [static]
Dispatched when there was an error with the request for additional permissions
| FacebookAPISessionEvent | ||
SESSION_CLOSED : String = facebookapi:session:closed [static]
Dispatched when a Facebook session is logged out and closed. | FacebookAPISessionEvent | ||
SESSION_CLOSE_ERROR : String = facebookapi:session:close:error [static]
Dispatched when a Facebook session could not be closed. | FacebookAPISessionEvent | ||
SESSION_INFO : String = facebookapi:session:info [static]
Dispatched when a Facebook session is opened and information about the user is available
profile will contain any available profile information that was loaded
| FacebookAPISessionEvent | ||
SESSION_OPEN_CANCELLED : String = facebookapi:session:open:cancelled [static]
Dispatched when the user cancelled the login process. | FacebookAPISessionEvent | ||
SESSION_OPEN_DISABLED : String = facebookapi:session:open:disabled [static]
Dispatched when a session could not be opened because the user has disabled your application
in the iOS6+ Facebook settings on their device. | FacebookAPISessionEvent | ||
SESSION_OPENED : String = facebookapi:session:opened [static]
Dispatched when a Facebook session is logged in and opened
The event data field should contain the following properties:
accessToken The user's session access token
userId The logged in user's Facebook ID
| FacebookAPISessionEvent | ||
SESSION_OPEN_ERROR : String = facebookapi:session:open:error [static]
Dispatched when a Facebook session was not able to be opened. | FacebookAPISessionEvent |
accessToken | property |
public var accessToken:AccessToken = null
The current user access token or null
if one is not available
errorCode | property |
public var errorCode:int = -1
If an error occurred this will contain the code of that error
errorMessage | property |
public var errorMessage:String = null
If an error occurred this will contain a description of the error
profile | property |
public var profile:Profile = null
The current user profile, includes information about the user's name etc
or null
if profile information is not available
FacebookAPISessionEvent | () | Constructor |
public function FacebookAPISessionEvent(type:String, accessToken:AccessToken = null, profile:Profile = null, errorCode:int = -1, errorMessage:String = null, bubbles:Boolean = false, cancelable:Boolean = false)
Constructor
Parameterstype:String | |
accessToken:AccessToken (default = null )
| |
profile:Profile (default = null )
| |
errorCode:int (default = -1 )
| |
errorMessage:String (default = null )
| |
bubbles:Boolean (default = false )
| |
cancelable:Boolean (default = false )
|
clone | () | method |
override public function clone():Event
ReturnsEvent |
REQUEST_PERMISSIONS_CANCELLED | Constant |
public static const REQUEST_PERMISSIONS_CANCELLED:String = facebookapi:permissions:request:cancelled
Dispatched when the user cancelled the request for additional permissions
REQUEST_PERMISSIONS_COMPLETED | Constant |
public static const REQUEST_PERMISSIONS_COMPLETED:String = facebookapi:permissions:request:completed
Dispatched when a request for additional permissions was successful
REQUEST_PERMISSIONS_ERROR | Constant |
public static const REQUEST_PERMISSIONS_ERROR:String = facebookapi:permissions:request:error
Dispatched when there was an error with the request for additional permissions
SESSION_CLOSE_ERROR | Constant |
public static const SESSION_CLOSE_ERROR:String = facebookapi:session:close:error
Dispatched when a Facebook session could not be closed.
errorMessage
will contain a description of the error
SESSION_CLOSED | Constant |
public static const SESSION_CLOSED:String = facebookapi:session:closed
Dispatched when a Facebook session is logged out and closed.
SESSION_INFO | Constant |
public static const SESSION_INFO:String = facebookapi:session:info
Dispatched when a Facebook session is opened and information about the user is available
profile
will contain any available profile information that was loaded
SESSION_OPEN_CANCELLED | Constant |
public static const SESSION_OPEN_CANCELLED:String = facebookapi:session:open:cancelled
Dispatched when the user cancelled the login process.
SESSION_OPEN_DISABLED | Constant |
public static const SESSION_OPEN_DISABLED:String = facebookapi:session:open:disabled
Dispatched when a session could not be opened because the user has disabled your application in the iOS6+ Facebook settings on their device.
SESSION_OPEN_ERROR | Constant |
public static const SESSION_OPEN_ERROR:String = facebookapi:session:open:error
Dispatched when a Facebook session was not able to be opened.
errorMessage
will contain a description of the error
SESSION_OPENED | Constant |
public static const SESSION_OPENED:String = facebookapi:session:opened
Dispatched when a Facebook session is logged in and opened
The event data field should contain the following properties: accessToken The user's session access token userId The logged in user's Facebook ID