Class: WKcServiceJSON

WKcServiceJSON

new WKcServiceJSON() → {Object}

WKcServiceJSON objects can be used to exchange JSON data with external data servers.
Source:
Returns:
A new service object.
Type
Object

Extends

Methods

ajax()

Asynchronosly exchanges data with an external data server.
Parameters:
Name Type Argument Default Description
p_args.url String The URL of the external data source.
p_args.requestMethod String <optional>
"get" The request method: "get" oder "post" oder head.
p_args.synchronous String <optional>
false Indicates, whether the data is exchaned synchronously or asynchronously.
p_args.timeout Number <optional>
0
p_args.responseType String <optional>
'text' The type of the data to be loaded.
p_args.dataIn String <optional>
this.data A data object into which the result data is to be put.
p_args.attrIn String <optional>
null The attribute of the data object into which the result data is put.
p_args.dataOutHeader String <optional>
null A data object that contains the key/value pairs that are to be sent to the server.
p_args.dataOut String <optional>
null A data object that contains the data that is to be send to the server.
p_args.attrOut String <optional>
null The attribute of the data object taht contains the data that is to be send to the server.
p_args.p_event String <optional>
$E$.DATA_CHANGED The event type signaled by dataIn after it has been changed.
Inherited From:
Source:
Fires:
  • $E$.event:AJAX_START
  • $E$.event:PROGRESS
  • $E$.event:ABORT
  • $E$.event:ERROR
  • $E$.event:LOAD
  • $E$.event:TIMEOUT
  • $E$.event:AJAX_END

data(p_data)

Sets the data object where the service shall save the data read by default.
Parameters:
Name Type Description
p_data $wk$.vclsd.data.WKcData A data object.
Inherited From:
Source:

json()

Asynchronosly exchanges data with an external data server.
Parameters:
Name Type Argument Default Description
p_args.p_url String The URL of the external data source.
p_args.p_synchronosly String <optional>
false Indicates, whether the data is exchaned synchronosly or asynchronosly.
p_args.p_data_in String <optional>
this.data || null A data object into which the data can be put.
p_args.p_attr_in String <optional>
null The attribute of the data object into which the result is put.
p_args.p_data_out String <optional>
null A data object into which the data can be put.
p_args.p_attr_out String <optional>
null The attribute of the data object into which the result is put.
p_args.p_response_type String <optional>
'text' A data object into which the data can be put.
p_args.p_event String <optional>
$E$.DATA_CHANGED The event type dispatched by p_data after it has been changed
p_args.p_request_method String <optional>
"get" The request method: "get" oder "post".
Source:
W. Kowarschick © 2013 (CC BY-NC-SA 3.0: http://creativecommons.org/licenses/by-nc-sa/3.0/)
Documentation generated by JSDoc 3.3.0-dev on Sat Oct 05 2013 15:14:39 GMT+0200 (MESZ) using the DocStrap template.