Function Namespace initPush
taoApi
Defined in: api.js.
Constructor Attributes | Constructor Name and Description |
---|---|
initPush(environment, settings)
Initialize the push communication.
|
Function Namespace Detail
initPush(environment, settings)
Initialize the push communication.
If you don't need to change the default values, don't call this function.
- Parameters:
- {Object} environment
- set to null if you want to keep all the default values
- {String} environment.url Optional, Default: "/taoDelivery/ResultDelivery/save"
- the url of the server where the data are sent
- {Object} environment.params Optional
- the additional parameters to send with the data
- {Object} settings
- set to null if you want to keep all the default values
- {String} settings.format Optional, Default: "json"
- the data format. Only json is supported in the current version
- {String} settings.method Optional, Default: "post"
- HTTP method to push the data (get|post)
- {boolean} settings.async Optional, Default: true
- if the request is asynchronous
- {boolean} settings.clearAfter Optional, Default: true
- if the variables stacks are cleared once the push is done