GPMessage
esri/tasks/support/GPMessageRepresents a message generated during the execution of a Geoprocessor task. It includes information such as when the processing started, what parameter values are being used, the task progress, and warnings of potential problems and errors. It is composed of a message type and description.
- See also:
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| String | The geoprocessing message. more details | more details | GPMessage | |
| String | The geoprocessing message type. more details | more details | GPMessage |
Property Details
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
- descriptionString
The geoprocessing message.
- typeString
The geoprocessing message type.
Possible Values: informative | process-definition | process-start | process-stop | warning | error | empty | abort
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | GPMessage | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | GPMessage |
Method Details
- fromJSON(json){*}static
Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input
jsonparameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameter:json ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
Returns:Type Description * Returns a new instance of this class.
- toJSON(){Object}
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.