ProcessingState Class¶

Represents the state of a processing action that is running asynchronously. Typically, this is a server-side processing task.

Inheritance Hierarchy¶

System.Object
Citrix.SDK.AppDNA.ProcessingState
Namespace: Citrix.SDK.AppDNA
Assembly: Citrix.SDK.AppDNA (in Citrix.SDK.AppDNA.dll) Version: 7.11.0.0 (7.11.0.0)

Syntax¶

C¶

public sealed class ProcessingState : INotifyPropertyChanged, 
    IDisposable

VB¶

Public NotInheritable Class ProcessingState
    Implements INotifyPropertyChanged, IDisposable

The ProcessingState type exposes the following members.

Properties¶

	Name	Description
	CancelRequested	Gets a value specifying whether there is a request to cancel the task or not. After cancellation is requested, the task may complete, fail or take time to stop due to cancellation.
	CurrentAction	Gets a string specifying the current action that the processing task is performing.
	CurrentActionDetail	Gets a string specifying more detail of the current action.
	DateEnded	Gets a DateTime that specifies the time that the task finished. Will be null if it has not yet finished.
	DateStarted	Gets a DateTime that specifies the time that the task was created.
	Description	Gets a description of the task.
	HasWarnings	Gets whether the task has warnings
	InitiatingUserName	Gets the AppDNA username of the user that initiated the task.
	IsFinished	Gets a value specifying if the server side processing has no more work to do.
	LogFile	Gets a log file path, if any, associated with the current processing.
	Name	Gets the name of the task.
	Progress	Gets the current progress as a percentage. May be null if the task has not yet started or the task does not support progress reporting.
	Result	Gets a string representing the result of the task.
	State	Gets a value specifying the current running state of the task.

Back to Top

Methods¶

	Name	Description
	Dispose	Immediately frees up resources held by this object.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WaitForCompletion()	Waits for long running operation completes. Completion will occur regardless of success, failure or cancellation. Use a State property to detect the reason.
	WaitForCompletion(TimeSpan)	Waits for long running operation completes. Completion will occur regardless of success, failure or cancellation. Use a State property to detect the reason.