Interface IExternalJobExecutionContext

Namespace: Sdl.Desktop.IntegrationApi.Jobs
Assembly: Sdl.Desktop.IntegrationApi.dll
Syntax
public interface IExternalJobExecutionContext

Properties

CancelRequested

True if the job request was cancelled by the user. When this property returns true, just return from the Execute(IExternalJobExecutionContext) method to complete the cancellation process.

Declaration
bool CancelRequested { get; }
Property Value
Type Description
bool

Methods

Cancel()

Call this method to cancel to job request.

Declaration
void Cancel()
Remarks

After calling this method, you must return from the Execute(IExternalJobExecutionContext) method to complete the cancellation process.

ReportProgress(int, string)

Reports progress on this job.

Declaration
void ReportProgress(int percentComplete, string statusMessage)
Parameters
Type Name Description
int percentComplete

The percentage (0-100) of this job that is currently completed.
string statusMessage

A message indicating which operation the job is currently performing.

Extension Methods