dojo/rpc/RpcService (version 1.10)

Summary

TODOC

Usage

var foo = new RpcService(args);
dojo/rpc/RpcService
Parameter Type Description
args object

Takes a number of properties as kwArgs for defining the service. It also accepts a string. When passed a string, it is treated as a url from which it should synchronously retrieve an smd file. Otherwise it is a kwArgs object. It accepts serviceUrl, to manually define a url for the rpc service allowing the rpc system to be used without an smd definition. strictArgChecks forces the system to verify that the # of arguments provided in a call matches those defined in the smd. smdString allows a developer to pass a jsonString directly, which will be converted into an object or alternatively smdObject is accepts an smdObject directly.

See the dojo/rpc/RpcService reference documentation for more information.

Property Summary

Method Summary

  • errorCallback(deferredRequestHandler) create callback that calls the Deferred errback method
  • generateMethod(method,parameters,url) generate the local bind methods for the remote object
  • parseResults(obj) parse the results coming back from an rpc request. this base implementation, just returns the full object subclasses should parse and only return the actual results
  • processSmd(object) callback method for receipt of a smd object.
  • resultCallback(deferredRequestHandler) create callback that calls the Deferred's callback method

Properties

serviceUrl
Defined by: dojo/rpc/RpcService
strictArgChecks
Defined by: dojo/rpc/RpcService

Methods

errorCallback(deferredRequestHandler)
Defined by dojo/rpc/RpcService

create callback that calls the Deferred errback method

Parameter Type Description
deferredRequestHandler dojo/_base/Deferred

The deferred object handling a request.

Returns:function
generateMethod(method,parameters,url)
Defined by dojo/rpc/RpcService

generate the local bind methods for the remote object

Parameter Type Description
method string

The name of the method we are generating

parameters dojo/_base/array

the array of parameters for this call.

url string

the service url for this call

Returns:undefined
parseResults(obj)
Defined by dojo/rpc/RpcService

parse the results coming back from an rpc request. this base implementation, just returns the full object subclasses should parse and only return the actual results

Parameter Type Description
obj Object

Object that is the return results from an rpc request

Returns:Object

Object that is the return results from an rpc request

processSmd(object)
Defined by dojo/rpc/RpcService

callback method for receipt of a smd object. Parse the smd and generate functions based on the description

Parameter Type Description
object undefined

smd object defining this service.

resultCallback(deferredRequestHandler)
Defined by dojo/rpc/RpcService

create callback that calls the Deferred's callback method

Parameter Type Description
deferredRequestHandler dojo/_base/Deferred

The deferred object handling a request.

Returns:undefined
Error in the documentation? Can’t find what you are looking for? Let us know!