org.restfulx.services.as3http.AS3XMLHTTPServiceProvider

	Property	Defined by
		id : int [read-only] ID uniquely identifies this service provider.	AS3XMLHTTPServiceProvider
		rootUrl : String Root URL that this service provider will prefix to all requests.	XMLHTTPServiceProvider

	Property	Defined by
		contentType : String	AS3XMLHTTPServiceProvider
		serializer : ISerializer	XMLHTTPServiceProvider
		state : ModelsMetadata	XMLHTTPServiceProvider
		urlSuffix : String	XMLHTTPServiceProvider

	Method	Defined by
		AS3XMLHTTPServiceProvider(httpRootUrl:String = null)	AS3XMLHTTPServiceProvider
		canLazyLoad():Boolean Indicates if this service provider can perform lazy loading.	XMLHTTPServiceProvider
		create(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void RESTful CRUD contract: create method.	AS3XMLHTTPServiceProvider
		destroy(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void RESTful CRUD contract: destroy method.	AS3XMLHTTPServiceProvider
		hasErrors(object:Object):Boolean Indicates to the ServiceResponder that this particular run (typically create/update or destroy) has produced errors.	XMLHTTPServiceProvider
		index(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void RESTful CRUD contract: index method.	AS3XMLHTTPServiceProvider
		marshall(object:Object, recursive:Boolean = false):Object Produces service provider specific model representation suitable for being serialized.	XMLHTTPServiceProvider
		show(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void RESTful CRUD contract: show method.	AS3XMLHTTPServiceProvider
		unmarshall(object:Object, disconnected:Boolean = false, defaultType:String = null):Object The reverse of marshall.	XMLHTTPServiceProvider
		update(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void RESTful CRUD contract: update method.	AS3XMLHTTPServiceProvider

	Method	Defined by
		addHeaders(request:URLRequest, headers:Object):void	XMLHTTPServiceProvider
		addHeadersToHttpRequest(request:HttpRequest):HttpRequest	AS3XMLHTTPServiceProvider
		decodeResult(result:Object):Object	XMLHTTPServiceProvider
		getCreateOrUpdateHttpClient(object:Object, responder:IResponder, metadata:Object, nestedBy:Array, recursive:Boolean = false, undoRedoFlag:int = 0, creating:Boolean = false):HttpClient	AS3XMLHTTPServiceProvider
		getHttpClient(onDataComplete:Function, onError:Function = null):HttpClient	AS3XMLHTTPServiceProvider
		getIndexOrShowHttpClient(responder:IResponder):HttpClient	AS3XMLHTTPServiceProvider
		getURLLoader():URLLoader	XMLHTTPServiceProvider
		getURLRequest(object:Object, nestedBy:Array = null):URLRequest	XMLHTTPServiceProvider
		invokeCreateOrUpdateURLRequest(request:URLRequest, responder:IResponder, object:Object, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0, creating:Boolean = false):void	XMLHTTPServiceProvider
		invokeMultiPartRequest(request:URLRequest, object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0, creating:Boolean = false):void	XMLHTTPServiceProvider
		invokeURLRequest(request:URLRequest, responder:IResponder):void	XMLHTTPServiceProvider
		marshallToURLVariables(source:Object):URLVariables	XMLHTTPServiceProvider
		marshallToVO(object:Object, recursive:Boolean = false, toDelete:Boolean = false):Object	XMLHTTPServiceProvider
		sendOrUpload(request:URLRequest, object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0, creating:Boolean = false):void	XMLHTTPServiceProvider
		uploadFile(request:URLRequest, object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0, creating:Boolean = false):void	XMLHTTPServiceProvider
		urlEncodeMetadata(metadata:Object = null):String	XMLHTTPServiceProvider

	Constant	Defined by
		ID : int [static] service id	AS3XMLHTTPServiceProvider

Property detail

contentType

property

protected var contentType:String

property

id:int [read-only]

ID uniquely identifies this service provider. This is typically obtained from ServiceManager like so: public static const ID:int = ServiceManager.generateId(); You can then wrap around this with a getter: public function get id():int { return ID; }

Implementation
public function get id():int

Constructor detail

AS3XMLHTTPServiceProvider

()

constructor

public function AS3XMLHTTPServiceProvider(httpRootUrl:String = null)

Parameters

httpRootUrl:String (default = null) — root URL that this service provider will prefix to all requests. By default this will be equal to Rx.httpRootUrl parameter

Method detail

addHeadersToHttpRequest

()

method

protected function addHeadersToHttpRequest(request:HttpRequest):HttpRequestParameters

request:HttpRequest

Returns

HttpRequest

create

()

method

public override function create(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void

RESTful CRUD contract: create method. Same semantics as Rails RESTful controller create.

Parameters

	`object:Object` — object to create (typically a new model instance)

	`responder:IResponder` — the responder that must be called on index

	`metadata:Object` (default = `null`) — any metadata that must be appended with the index request

	`nestedBy:Array` (default = `null`) — an array of model instances that will be used to nest this request, e.g.: [project, user] where project is some Project model instance and user is some User model instance. In case of XMLHTTPServiceProvider nesting may require additional configuration on the server. If you are using Rails see config/routes.rb for more details.

	`recursive:Boolean` (default = `false`) — indicates if recursive create (object + all children) should be performed

	`undoRedoFlag:int` (default = `0`) — indicates if it's a normal invocation, undo invocation or redo invocation

destroy

()

method

public override function destroy(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void

RESTful CRUD contract: destroy method. Same semantics as Rails RESTful controller destroy.

Parameters

	`object:Object` — object to destroy (typically an existing model instance)

	`responder:IResponder` — the responder that must be called on index

	`metadata:Object` (default = `null`) — any metadata that must be appended with the index request

	`nestedBy:Array` (default = `null`) — an array of model instances that will be used to nest this request, e.g.: [project, user] where project is some Project model instance and user is some User model instance. In case of XMLHTTPServiceProvider nesting may require additional configuration on the server. If you are using Rails see config/routes.rb for more details.

	`recursive:Boolean` (default = `false`) — indicates if recursive create (object + all children) should be performed

	`undoRedoFlag:int` (default = `0`) — indicates if it's a normal invocation, undo invocation or redo invocation

getCreateOrUpdateHttpClient

()

method

protected function getCreateOrUpdateHttpClient(object:Object, responder:IResponder, metadata:Object, nestedBy:Array, recursive:Boolean = false, undoRedoFlag:int = 0, creating:Boolean = false):HttpClient

Parameters

	`object:Object`

	`responder:IResponder`

	`metadata:Object`

	`nestedBy:Array`

	`recursive:Boolean` (default = `false`)

	`undoRedoFlag:int` (default = `0`)

	`creating:Boolean` (default = `false`)

Returns

HttpClient

getHttpClient

()

method

protected function getHttpClient(onDataComplete:Function, onError:Function = null):HttpClientParameters

	`onDataComplete:Function`

	`onError:Function` (default = `null`)

Returns

HttpClient

getIndexOrShowHttpClient

()

method

protected function getIndexOrShowHttpClient(responder:IResponder):HttpClientParameters

responder:IResponder

Returns

HttpClient

index

()

method

public override function index(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void

RESTful CRUD contract: index method. Same semantics as Rails RESTful controller index.

Parameters

	`object:Object` — object to index (typically a class like Project, etc)

	`responder:IResponder` — the responder that must be called on index

	`metadata:Object` (default = `null`) — any metadata that must be appended with the index request

	`nestedBy:Array` (default = `null`) — an array of model instances that will be used to nest this request, e.g.: [project, user] where project is some Project model instance and user is some User model instance. In case of XMLHTTPServiceProvider nesting may require additional configuration on the server. If you are using Rails see config/routes.rb for more details.

show

()

method

public override function show(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void

RESTful CRUD contract: show method. Same semantics as Rails RESTful controller show.

Parameters

	`object:Object` — object to show (typically a model instance as opposed to class)

	`responder:IResponder` — the responder that must be called on index

	`metadata:Object` (default = `null`) — any metadata that must be appended with the index request

	`nestedBy:Array` (default = `null`) — an array of model instances that will be used to nest this request, e.g.: [project, user] where project is some Project model instance and user is some User model instance. In case of XMLHTTPServiceProvider nesting may require additional configuration on the server. If you are using Rails see config/routes.rb for more details.

update

()

method

public override function update(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void

RESTful CRUD contract: update method. Same semantics as Rails RESTful controller update.

Parameters

	`object:Object` — object to update (typically an existing model instance)

	`responder:IResponder` — the responder that must be called on index

	`metadata:Object` (default = `null`) — any metadata that must be appended with the index request

	`nestedBy:Array` (default = `null`) — an array of model instances that will be used to nest this request, e.g.: [project, user] where project is some Project model instance and user is some User model instance. In case of XMLHTTPServiceProvider nesting may require additional configuration on the server. If you are using Rails see config/routes.rb for more details.

	`recursive:Boolean` (default = `false`) — indicates if recursive create (object + all children) should be performed

	`undoRedoFlag:int` (default = `0`) — indicates if it's a normal invocation, undo invocation or redo invocation

Constant detail

constant

public static const ID:int

service id

"RestfulX Framework 1.3.1 API Documenation"	All Packages \| All Classes \| Index \| Frames No Frames
Class AS3XMLHTTPServiceProvider	Properties \| Methods \| Constants

Package	org.restfulx.services.as3http
Class	public class AS3XMLHTTPServiceProvider
Inheritance	AS3XMLHTTPServiceProvider XMLHTTPServiceProvider
Subclasses	AS3GAEHTTPServiceProvider, AS3JSONHTTPServiceProvider