import CircuitVerifyJobInfo from "@arcgis/core/networks/support/CircuitVerifyJobInfo.js";const CircuitVerifyJobInfo = await $arcgis.import("@arcgis/core/networks/support/CircuitVerifyJobInfo.js");- Inheritance
- CircuitVerifyJobInfo→
VerifyCircuitsResult→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 5.1
Represents information pertaining to the execution of an asynchronous CircuitManager.submitVerifyJob() request on the server.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| readonly inherited | ||
| | ||
| | ||
| | ||
| |
statusUrl
- Type
- string
ArcGIS Server Rest API endpoint to the resource that receives the verify circuits request.
submissionTime
The date and time in which CircuitManager.submitVerifyJob() is first called.
Methods
| Method | Signature | Class |
|---|---|---|
| inherited static | fromJSON(json: any): any | |
| checkJobStatus(requestOptions?: RequestOptions | null): Promise<CircuitVerifyJobInfo> | | |
| destroy(): void | | |
| inherited | toJSON(): any | |
| waitForJobCompletion(options?: WaitForVerifyOptions): Promise<CircuitVerifyJobInfo> | |
fromJSON
- Signature
-
fromJSON (json: any): any
Creates a new instance of this class and initializes it with values from a JSON object
generated from an ArcGIS product. 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.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | 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
- any
Returns a new instance of this class.
checkJobStatus
- Signature
-
checkJobStatus (requestOptions?: RequestOptions | null): Promise<CircuitVerifyJobInfo>
Sends a request for the current state of this job.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| requestOptions | Additional options to be used for the data request (will override requestOptions defined during construction). | |
- Returns
- Promise<CircuitVerifyJobInfo>
When resolved, returns a CircuitVerifyJobInfo.
destroy
- Signature
-
destroy (): void
Stop monitoring this job for status updates.
// Stop monitoring this job for status updates.jobInfo.destroy();- See also
- Returns
- void
toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.
waitForJobCompletion
- Signature
-
waitForJobCompletion (options?: WaitForVerifyOptions): Promise<CircuitVerifyJobInfo>
Resolves when an asynchronous job has completed. Optionally job progress can be monitored.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| options | Options. See properties below for object specifications. | |
- Returns
- Promise<CircuitVerifyJobInfo>
When resolved, returns a CircuitVerifyJobInfo.