Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/workers
Class: GPMessage

require(["esri/tasks/GPMessage"], function(GPMessage) { /* code goes here */ });

Description

(Added at v1.0)
Represents a message generated during the execution of a geoprocessing task. It includes information such as when the processing started, what parameter values are being used, the task progress, warnings of potential problems and errors. It is composed of a message type and description. GPMessage has no constructor.

Samples

Search for samples that use this class.

Constants

NameDescription
TYPE_ABORTesriJobMessageTypeAbort - Indicates the job has aborted.
TYPE_EMPTYesriJobMessageTypeEmpty - Indicates the task returned an empty result.
TYPE_ERROResriJobMessageTypeError - Indicates an error was returned during the execution of the job.
TYPE_INFORMATIVEesriJobMessageTypeInformative - Indicates the message is informative.
TYPE_PROCESS_DEFINITIONesriJobMessageTypeProcessDefinition
TYPE_PROCESS_STARTesriJobMessageTypeProcessStart - Indicates the GP process has started.
TYPE_PROCESS_STOPesriJobMessageTypeProcessStop - Indicates the GP process has stopped.
TYPE_WARNINGesriJobMessageTypeWarning - Indicates the message is a warning.

Properties

NameTypeSummary
descriptionStringA description of the geoprocessing message.
typeStringThe geoprocessing message type.
Property Details

<String> description

A description of the geoprocessing message.

<String> type

The geoprocessing message type. This can be any value listed in the constants table above.