com.distriqt.extension.facebookapi.graphapi.builders.GraphAPIRequestBuilder

	Method	Defined By
		GraphAPIRequestBuilder() Constructor	GraphAPIRequestBuilder
		addField(field:String):GraphAPIRequestBuilder Add a field to be requested with the graph request	GraphAPIRequestBuilder
		addFields(fields:Array):GraphAPIRequestBuilder Add an array of fields to the request.	GraphAPIRequestBuilder
		addParameter(name:String, value:Object):GraphAPIRequestBuilder Add a parameter to the request	GraphAPIRequestBuilder
		build():GraphAPIRequest Builds the request object	GraphAPIRequestBuilder
		getCurrentPermissionsRequest():GraphAPIRequest [static]	GraphAPIRequestBuilder
		getCurrentUserInfoRequest():GraphAPIRequest [static]	GraphAPIRequestBuilder
		getUserFriendsRequest():GraphAPIRequest [static]	GraphAPIRequestBuilder
		getUserFriendsWithInstalledRequest():GraphAPIRequest [static]	GraphAPIRequestBuilder
		postImageToDefaultAlbumRequest(image:BitmapData, message:String):GraphAPIRequest [static]	GraphAPIRequestBuilder
		postLinkToWallRequest(linkUrl:String, caption:String, message:String, description:String):GraphAPIRequest [static]	GraphAPIRequestBuilder
		postStatusUpdateRequest(message:String):GraphAPIRequest [static]	GraphAPIRequestBuilder
		setCompleteCallback(callback:Function):GraphAPIRequestBuilder Sets the callback function for successful completion of this request.	GraphAPIRequestBuilder
		setErrorCallback(callback:Function):GraphAPIRequestBuilder Sets the callback for an error on this request	GraphAPIRequestBuilder
		setImage(image:BitmapData):GraphAPIRequestBuilder Add custom image data to be sent with a graph request.	GraphAPIRequestBuilder
		setMethod(method:String):GraphAPIRequestBuilder Sets the HTTP method to use for this request	GraphAPIRequestBuilder
		setPath(apiPath:String):GraphAPIRequestBuilder The graph API endpoint for the request	GraphAPIRequestBuilder

	Constant	Defined By
		METHOD_DELETE : String = DELETE [static]	GraphAPIRequestBuilder
		METHOD_GET : String = GET [static]	GraphAPIRequestBuilder
		METHOD_POST : String = POST [static]	GraphAPIRequestBuilder

Constructor Detail

GraphAPIRequestBuilder

()

Constructor

public function GraphAPIRequestBuilder()

Constructor

Method Detail

addField

()

method

public function addField(field:String):GraphAPIRequestBuilder

Add a field to be requested with the graph request

Parameters

field:String — String name of the field to be added to the request

Returns

GraphAPIRequestBuilder — GraphAPIRequestBuilder instance for chaining calls

addFields

()

method

public function addFields(fields:Array):GraphAPIRequestBuilder

Add an array of fields to the request. This must be an array of String values each representing a different field to add to the request.

Parameters

fields:Array — Must be an Array of String fields

Returns

GraphAPIRequestBuilder — GraphAPIRequestBuilder instance for chaining calls

Example

         new GraphAPIRequestBuilder()
                 .setPath( "/me" )
                 .addFields( [ "email", "name" ] )
                 .build();

addParameter

()

method

public function addParameter(name:String, value:Object):GraphAPIRequestBuilder

Add a parameter to the request

Parameters

	`name:String` — String name of the parameter

	`value:Object` — The value of the parameter

Returns

GraphAPIRequestBuilder — GraphAPIRequestBuilder instance for chaining calls

build

()

method

public function build():GraphAPIRequest

Builds the request object

Returns

GraphAPIRequest — A valid GraphAPIRequest instance for making a Graph API request

getCurrentPermissionsRequest

()

method

public static function getCurrentPermissionsRequest():GraphAPIRequest

Returns

GraphAPIRequest

getCurrentUserInfoRequest

()

method

public static function getCurrentUserInfoRequest():GraphAPIRequest

Returns

GraphAPIRequest

getUserFriendsRequest

()

method

public static function getUserFriendsRequest():GraphAPIRequest

Returns

GraphAPIRequest

getUserFriendsWithInstalledRequest

()

method

public static function getUserFriendsWithInstalledRequest():GraphAPIRequest

Returns

GraphAPIRequest

postImageToDefaultAlbumRequest

()

method

public static function postImageToDefaultAlbumRequest(image:BitmapData, message:String):GraphAPIRequest

Parameters

	`image:BitmapData`

	`message:String`

Returns

GraphAPIRequest

postLinkToWallRequest

()

method

 public static function postLinkToWallRequest(linkUrl:String, caption:String, message:String, description:String):GraphAPIRequest

Parameters

	`linkUrl:String`

	`caption:String`

	`message:String`

	`description:String`

Returns

GraphAPIRequest

postStatusUpdateRequest

()

method

public static function postStatusUpdateRequest(message:String):GraphAPIRequest

Parameters

message:String

Returns

GraphAPIRequest

setCompleteCallback

()

method

public function setCompleteCallback(callback:Function):GraphAPIRequestBuilder

Sets the callback function for successful completion of this request.

Parameters

callback:Function — A function that takes an Object parameter. This will be the same as the GraphAPIRequestEvent.COMPLETE event data property.

Returns

GraphAPIRequestBuilder — GraphAPIRequestBuilder instance for chaining calls

setErrorCallback

()

method

public function setErrorCallback(callback:Function):GraphAPIRequestBuilder

Sets the callback for an error on this request

Parameters

callback:Function — A function that takes a int and String parameters representing the error code and message.

Returns

GraphAPIRequestBuilder — GraphAPIRequestBuilder instance for chaining calls

setImage

()

method

public function setImage(image:BitmapData):GraphAPIRequestBuilder

Add custom image data to be sent with a graph request. Most commonly used for uploading photos, etc.

Parameters

image:BitmapData — BitmapData representation of the image to be attached

Returns

GraphAPIRequestBuilder — GraphAPIRequestBuilder instance for chaining calls

setMethod

()

method

public function setMethod(method:String):GraphAPIRequestBuilder

Sets the HTTP method to use for this request

Parameters

method:String — The HTTP method, may be "GET", "DELETE" or "POST"

Returns

GraphAPIRequestBuilder — GraphAPIRequestBuilder instance for chaining calls

setPath

()

method

public function setPath(apiPath:String):GraphAPIRequestBuilder

The graph API endpoint for the request

Parameters

apiPath:String — The graph API endpoint for the request

Returns

GraphAPIRequestBuilder — GraphAPIRequestBuilder instance for chaining calls

Constant Detail

METHOD_DELETE

Constant

public static const METHOD_DELETE:String = DELETE

METHOD_GET

Constant

public static const METHOD_GET:String = GET

METHOD_POST

Constant

public static const METHOD_POST:String = POST

Examples

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

Tue Oct 20 2020, 10:03 PM +10:00

distriqt // FacebookAPI Native Extension Documentation	All Packages \| All Classes \| Index \| Frames No Frames
GraphAPIRequestBuilder	Methods \| Constants \| Examples

Package	com.distriqt.extension.facebookapi.graphapi.builders
Class	public class GraphAPIRequestBuilder
Inheritance	GraphAPIRequestBuilder Object