Packagecom.marpies.ane.facebook.games
Interfacepublic interface IAIRFacebookGameRequests extends flash.events.IEventDispatcher

Interface providing Facebook Game Requests APIs.



Public Properties
 PropertyDefined By
  canShowDialog : Boolean
[read-only] Call this to find out if a Game Request dialog can be presented on current device.
IAIRFacebookGameRequests
Public Methods
 MethodDefined By
  
Adds object that will be notified when your application is invoked from a Game Request notification.
IAIRFacebookGameRequests
  
deleteGameRequest(requestID:String, listener:IAIRFacebookOpenGraphListener = null):void
Deletes app request from the Facebook.
IAIRFacebookGameRequests
  
loadUserGameRequests(fields:Vector.<String> = null, listener:IAIRFacebookUserGameRequestsListener = null):void
Requests game requests which were sent to the logged in user.
IAIRFacebookGameRequests
  
Removes object that was added earlier using addGameRequestInvokeListener.
IAIRFacebookGameRequests
  
showDialog(message:String, actionType:String = null, title:String = null, objectID:String = null, friendsFilter:String = null, data:String = null, suggestedFriends:Vector.<String> = null, recipients:Vector.<String> = null, listener:IAIRFacebookGameRequestListener = null):void
Opens up web dialog to send the specified game request.
IAIRFacebookGameRequests
Property Detail
canShowDialogproperty
canShowDialog:Boolean  [read-only]

Call this to find out if a Game Request dialog can be presented on current device.


Implementation
    public function get canShowDialog():Boolean

See also

Method Detail
addGameRequestInvokeListener()method
public function addGameRequestInvokeListener(listener:IAIRFacebookGameRequestInvokeListener):void

Adds object that will be notified when your application is invoked from a Game Request notification. This object is retained for as long as the extension is active or until AIRFacebook.removeGameRequestInvokeListener() is called.

Parameters

listener:IAIRFacebookGameRequestInvokeListener — Object to be notified when your application is invoked from a Game Request notification.

See also

deleteGameRequest()method 
public function deleteGameRequest(requestID:String, listener:IAIRFacebookOpenGraphListener = null):void

Deletes app request from the Facebook. The requests are never deleted automatically, it is a developer's responsibility to do so on user's behalf, typically after the user accepted the request.

Since this is simply an Open Graph DELETE request your app must be granted publish_actions permission to succeed with this call.

If successful, result JSON typically contains only confirmation of the operation.

Parameters

requestID:String — ID of the app request to delete.
 
listener:IAIRFacebookOpenGraphListener (default = null) — Object that will be notified about the request result.


Events
openGraphRequestResult:AIRFacebookOpenGraphEvent — Dispatched when the result of the request is obtained.

See also

loadUserGameRequests()method 
public function loadUserGameRequests(fields:Vector.<String> = null, listener:IAIRFacebookUserGameRequestsListener = null):void

Requests game requests which were sent to the logged in user.

Parameters

fields:Vector.<String> (default = null) — Set of fields to pass to the request. Supported values are id, from, to, message, action_type, application, data, object, created_time. If no fields are specified then each app request in the result contains id, from, to, message, action_type, created_time and application.
 
listener:IAIRFacebookUserGameRequestsListener (default = null) — Object that will be notified about the request result.


Events
userGameRequestsRequestResult:AIRFacebookUserGameRequestsEvent — Dispatched when the result of the request is obtained.

See also

removeGameRequestInvokeListener()method 
public function removeGameRequestInvokeListener(listener:IAIRFacebookGameRequestInvokeListener):void

Removes object that was added earlier using addGameRequestInvokeListener.

Parameters

listener:IAIRFacebookGameRequestInvokeListener — Object to remove.

See also

showDialog()method 
public function showDialog(message:String, actionType:String = null, title:String = null, objectID:String = null, friendsFilter:String = null, data:String = null, suggestedFriends:Vector.<String> = null, recipients:Vector.<String> = null, listener:IAIRFacebookGameRequestListener = null):void

Opens up web dialog to send the specified game request.

Parameters

message:String — Message that users receiving the request will see; maximum 60 characters.
 
actionType:String (default = null) — Used when defining additional context about the nature of the request. Use either a value from AIRFacebookGameRequestActionType class or null which means value of AIRFacebookGameRequestActionType.NONE will be used.
 
title:String (default = null) — Optional title for the dialog; maximum 50 characters.
 
objectID:String (default = null) — Open Graph ID of an object that is being sent or asked for. Only valid (and required) for request types AIRFacebookGameRequestActionType.SEND and AIRFacebookGameRequestActionType.ASK_FOR.
 
friendsFilter:String (default = null) — Controls the set of friends user sees in the multi-friend selector dialog. Use AIRFacebookGameRequestFilter.APP_USERS to only display friends who are existing users of your app, or AIRFacebookGameRequestFilter.APP_NON_USERS to only display friends who have previously not authenticated your app. If null, the multi-friend selector will display all of the user's friends.
 
data:String (default = null) — Optional data which can be used for tracking; maximum 255 characters.
 
suggestedFriends:Vector.<String> (default = null) — An array of user IDs that will be included in the dialog as the first suggested friends. Cannot be used together with friendsFilter.
 
recipients:Vector.<String> (default = null) — List of user IDs, usernames or invite tokens of people to send the request to. If this is not specified, a friend selector will be displayed and the user can select up to 50 friends.
 
listener:IAIRFacebookGameRequestListener (default = null) — Object that will be notified about the request result.


Events
gameRequestRequestResult:AIRFacebookGameRequestEvent — Dispatched when the result of the request is obtained.

See also