NAMessage
esri/tasks/support/NAMessage
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.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | The name of the class. more details | more details | Accessor | |
String | A description of the network analyst message. more details | more details | NAMessage | |
String | The network analyst message type. more details | more details | NAMessage |
Property Details
- 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 details | NAMessage | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | NAMessage |
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 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.