Class wm.ServiceCallBaseMixin
Defined in: ServiceVariableBase.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Infrastructure for encapsulating a wm.Service configuration with a trigger to invoke the configured service.
|
Property Attributes | Property Name and Description |
---|---|
Note: to support bindings it is recommend that you use the getValue/setValue API to access or modify properties.
|
|
Set true to automatically update this service when it's created and
anytime the service configuration or input is modified.
|
|
Name of the operation to invoke on the service.
|
|
Name of the service called by this object.
|
Method Attributes | Method Name and Description |
---|---|
onError(inData)
onError event fires whenever a service reports an error.
|
|
onResult(inData)
onResult event fires whenever a service returns, whether the
service returned successfully or reported an error.
|
|
onSuccess(inData)
onSuccess event fires whenever a service returns successfully.
|
|
update()
Invoke the service.
|
Class Detail
wm.ServiceCallBaseMixin()
Infrastructure for encapsulating a wm.Service configuration with a trigger to invoke the configured service.
Report errata or suggestions for
ServiceCallBaseMixin.
Property Detail
Note: to support bindings it is recommend that you use the getValue/setValue API to access or modify properties.
{String}
autoUpdate
Set true to automatically update this service when it's created and
anytime the service configuration or input is modified.
Report errata or suggestions for
autoUpdate.
{String}
operation
Name of the operation to invoke on the service.
Report errata or suggestions for
operation.
{String}
service
Name of the service called by this object.
Report errata or suggestions for
service.
Method Detail
onError(inData)
onError event fires whenever a service reports an error.
- Parameters:
- {Any} inData
- Result data. The format of this data on the service.
Report errata or suggestions for
onError.
onResult(inData)
onResult event fires whenever a service returns, whether the
service returned successfully or reported an error.
- Parameters:
- {Any} inData
- Result data. The format of this data on the service.
Report errata or suggestions for
onResult.
onSuccess(inData)
onSuccess event fires whenever a service returns successfully.
- Parameters:
- {Any} inData
- Result data. The format of this data on the service.
Report errata or suggestions for
onSuccess.
update()
Invoke the service.
Use the onResult,
onSuccess,
and/or onError events
to monitor the outcome of the service call.
Report errata or suggestions for
update.