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

Description

WMTokenTask class to perform operations on Workflow Manager (Classic) Tokens.

Class hierarchy

workflowmanager/BaseTask
|_workflowmanager/WMTokenTask

Constructors

ConstructorDescription
new WMTokenTask(url)Constructor for WMTokenTask. 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
parseTokens(jobId, stringToParse, user, callback, errback)noneParses a string with embedded tokens using user and job info.
Constructor Details

new WMTokenTask(url)

Constructor for WMTokenTask. Disable client caching is default to be true.
Parameters:
<string>urlRequiredThe base Workflow Manager (Classic) REST URL.
Sample: 
require([
    "workflowmanager/WMTokenTask", ...
], function(WMTokenTask, ...) {
    var wmTokenTask = new WMTokenTask("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

parseTokens(jobId, stringToParse, user, callback, errback)

Parses a string with embedded tokens using user and job info.
Input Parameters:
<int> jobIdRequiredThe job Id.
<string> stringToParseRequiredThe string with tokens to parse.
<string> userRequiredThe user name.
<function> callbackOptionalThe success callback function name.
<function> errbackOptionalThe error callback function name.
Sample: 
require([
    "workflowmanager/WMTokenTask", ...
], function ParseTokens {
        var stringToParse = "[JOB:ID]";
        wmTokenTask.parseTokens(401, stringToParse, "cjones",
            function () {
                alert("Token parsed successfully.")
            }, function () {
                alert("Failed to parse token.")
            }    
});