dojo/rpc/RpcService.js

• Provides:

  • dojo.rpc.RpcService

• dojo.rpc.RpcService

  • type

    Function

  • parameters:
    • args: (typeof 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.

  • summary

    Take a string as a url to retrieve an smd or an object that is an smd or partial smd to use
    as a definition for the service

• dojo.rpc.RpcService.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • args: (typeof 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.

  • summary

    Take a string as a url to retrieve an smd or an object that is an smd or partial smd to use
    as a definition for the service

• dojo.rpc.RpcService.strictArgChecks

  • type

    Object

• dojo.rpc.RpcService.serviceUrl

  • type

    Object

• dojo.rpc.RpcService.parseResults

  • parameters:
    • obj: (typeof Object)

      Object that is the return results from an rpc request

  • type

    Function

• dojo.rpc.RpcService.errorCallback

  • parameters:
    • deferredRequestHandler: (typeof dojo.Deferred)

      Deferred The deferred object handling a request.

  • summary

    create callback that calls the Deferres errback method

  • type

    Function

• dojo.rpc.RpcService.resultCallback

  • parameters:
    • deferredRequestHandler: (typeof dojo.Deferred)

      Deferred The deferred object handling a request.

  • summary

    create callback that calls the Deferred's callback method

  • type

    Function

• dojo.rpc.RpcService.generateMethod

  • parameters:
    • method: (typeof string)

      The name of the method we are generating

    • parameters: (typeof array)

      the array of parameters for this call.

    • url: (typeof string)

      the service url for this call

  • summary

    generate the local bind methods for the remote object

  • type

    Function

• dojo.rpc.RpcService.processSmd

  • parameters:
    • object: (typeof smd)

      object defining this service.

  • summary

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

  • type

    Function

• dojo.rpc.RpcService.required

• dojo.rpc.RpcService.smd

• dojo.rpc.RpcService.timeout

  • type

    Number

• dojo.rpc

  • type

    Object

• dojo

  • type

    Object