GPMessage

Class: esri/tasks/support/GPMessage
Inheritance: GPMessage Accessor
Since: ArcGIS API for JavaScript 4.0

Represents 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

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

The geoprocessing message.

more details
more detailsGPMessage
String

The geoprocessing message type.

more details
more detailsGPMessage

Property Details

declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

descriptionString

The geoprocessing message.

typeString

The geoprocessing message type.

Known Values: informative | process-definition | process-start | process-stop | warning | error | empty | abort

Method Overview

NameReturn TypeSummaryClass
*

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 detailsGPMessage
Object

Converts an instance of this class to its ArcGIS Portal JSON representation.

more details
more detailsGPMessage

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 json parameter 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 Object

A 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:
TypeDescription
*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:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.