Hide Table of Contents
Class: WMAOILayerTask
[AMD Module Require]
require(["workflowmanager/WMAOILayerTask"], function(WMAOILayerTask) { /* code goes here */ });;

Description

WMAOILayerTask class to access Workflow Manager (Classic) AOI layer information.

Class hierarchy

workflowmanager/BaseTask
|_workflowmanager/WMAOILayerTask

Constructors

NameSummary
new WMAOILayerTask(url)Constructor for WMAOILayerTask. Disable client caching is default to be true.

Properties

NameTypeSummary
disableClientCachingBooleanThe indicator to disable client browser caching.
proxyURLStringThe proxy URL.
tokenStringThe token string if security is on.
urlStringThe base URL for Workflow Manager (Classic) service.

Methods

NameTypeSummary
getServiceInfo(callback, errback)noneGets the Workflow Manager (Classic) AOI layer information.
getJobIdField(callback, errback)noneGets the Workflow Manager (Classic) job Id field.
Constructor Details

new WMAOILayerTask(url)

Constructor for WMAOILayerTask. Disable client caching is default to be true.
Parameters:
<String>urlRequiredThe base Workflow Manager (Classic) REST URL.
Sample: 
require([
    "workflowmanager/WMAOILayerTask", ...
], function(WMAOILayerTask, ...) {
    var wmAOILayerTask = new wmAOILayerTask("http://myserver/arcgis/rest/services/WMService/WMServer");
    });
    ...
});
Property Details

<Boolean> disableClientCaching

The indicator to disable client browser caching.

<String> proxyURL

The proxy URL.

<String> token

The token string if security is on.

<String> url

The base URL for Workflow Manager (Classic) Service.
Method Details

getServiceInfo(callback, errback)

Gets the Workflow Manager (Classic) AOI layer information.
Input Parameters:
<function> callbackOptionalThe success callback function name.
<function> errbackOptionalThe error callback function name.
Sample: 
require([
    "workflowmanager/WMAOILayerTask", ...
], function(WMAOILayerTask, ...) {
    
    var wmAOILayerTask = new WMAOILayerTask("http://myserver/arcgis/rest/services/WMService/WMServer");
    var serviceInfo = null;
    wmAOILayerTask.getServiceInfo(function(data){
        serviceInfo = data;
    }, function (errData) {
        console.log("error:" + errData);
    });
    ...
});

getJobIdField(callback, errback)

Gets the Workflow Manager (Classic) job Id field.
Input Parameters:
<function> callbackOptionalThe success callback function name.
<function> errbackOptionalThe error callback function name.
Sample: 
require([
    "workflowmanager/WMAOILayerTask", ...
], function(WMAOILayerTask, ...) {
    
    var wmAOILayerTask = new WMAOILayerTask("http://myserver/arcgis/rest/services/WMService/WMServer");
    var jobIdField = null;
    wmAOILayerTask.getJobIdField(function(data){
        jobIdField = data;
    }, function (errData) {
        console.log("error:" + errData);
    });
    ...
});