Skip to main content

Graph API - Basics

caution

This is the legacy extension documentation. Find the new documentation here

Graph API Basics​

The Graph API implementation involves several classes. A builder class GraphAPIRequestBuilder is used to create a GraphAPIRequest which is then passed to the makeRequest function to actually perform the request.

The simplest example of this is retrieving the current user's information:

var request:GraphAPIRequest = new GraphAPIRequestBuilder()
    .setPath( "/me" )
    .build();

FacebookAPI.service.graphAPI.makeRequest( request );

Events​

A GraphAPIRequest will dispatch status events indicating the completion or failure of the request:

  • GraphAPIRequestEvent.COMPLETE: dispatched on successful completion
  • GraphAPIRequestEvent.ERROR: dispatched if there was an error
request.addEventListener( GraphAPIRequestEvent.COMPLETE, request_completeHandler );
request.addEventListener( GraphAPIRequestEvent.ERROR, request_errorHandler );
function request_completeHandler( event:GraphAPIRequestEvent ):void 
{
    // event.data will contain the Facebook response
    trace( JSON.stringify(event.data) );
}

function request_errorHandler( event:GraphAPIRequestEvent ):void 
{
    // event.errorCode and event.errorMessage will contain details on the error
    trace( event.errorMessage );
}

Callbacks​

As an alternative to events, you can add a callback function to a request:

var request:GraphAPIRequest = new GraphAPIRequestBuilder()
    .setPath( "/me" )
    .setCompleteCallback(
            function( data:Object ):void 
            {
                log( "request complete: " + JSON.stringify(data) );
            }
    )
    .setErrorCallback(
            function( code:int, message:String ):void 
            {
                log( "request error: " + code + "::"+ message );
            }
    )
    .build();

These functions must be of the specific format above, i.e. for the complete callback:

function( data:Object ):void 
{
    // process completion data
}

And the error callback:

function( errorCode:int, errorMessage:String ):void 
{
    // process request error
}

Builder​

The GraphAPIRequestBuilder is your main interface to constructing requests.

You must specify at least the Graph API endpoint you wish to query using the setPath function.

Fields and Parameters​

Most commands will have a list of optional parameters and/or fields. For example, the /me endpoint you can use the fields to add additional information you wish to retrieve. If you have requested the email permission for example, you can add the "email" field to return the users email address. To add a field use the addField or addFields function on the builder:

new GraphAPIRequestBuilder()
    .setPath( "/me" )
    .addField( "email" )
    .build();

Parameters are often additional information passed along with the request, for example a link passed along with a post request. To add a parameter use the addParameter function on the builder:

new GraphAPIRequestBuilder()
    .setPath( "/me/feed" )
    .setMethod( GraphAPIRequestBuilder.METHOD_POST )
    .addParameter( "link", "https://airnativeextensions.com" )
    .build();

Image Data​

If you wish to add image data to a post you can use the setImage function:

new GraphAPIRequestBuilder()
    .setPath( "/me/photos" )
    .setMethod( GraphAPIRequestBuilder.METHOD_POST )
    .setImage( yourBitmapData )
    .addParameter( "message", "Image posted through the Graph API from the Facebook API ANE" )
    .build();