In This Topic ▼

userToken Property

Summary

User token associated with this job.

Syntax

TypeScript

JavaScript

Object.defineProperty(CompareJobData.prototype, 'userToken', 
   get: function() 
)

readonly userToken: string;

Property Value

The user token associated with this job. The default value is null.

Remarks The UserToken and JobToken properties must be set by the application, prior to running the job, and combine them to create a unique string. Internally, the runner will use UserToken and JobToken as the Region and Key of the cache item added to the cache.

In normal cases, the UserToken can be set to the user name of the application and used for all the jobs submitted by the user. In contrast, JobToken should be a unique identifier for each job, and is usually set to a GUID.

UserToken and JobToken will then be passed by the application to the CompareJobRunner.queryJobStatus method to obtain the latest status of the job or to abort it with CompareJobRunner.abortJob.

Requirements

Target Platforms