NAMessage

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

Represents a message generated during the execution of a network analyst task. It is composed of a message type and description. NAMessage has no constructor.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
more detailsAccessor
String

A description of the network analyst message.

more details
more detailsNAMessage
String

The network analyst message type.

more details
more detailsNAMessage

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

description String

A description of the network analyst message.

type String

The network analyst 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 detailsNAMessage
Object

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

more details
more detailsNAMessage

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:
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() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.