Download full document:

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

 

NameDescription
Public propertyCancelRequested 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.
Public propertyCurrentAction Gets a string specifying the current action that the processing task is performing.
Public propertyCurrentActionDetail Gets a string specifying more detail of the current action.
Public propertyDateEnded Gets a DateTime that specifies the time that the task finished. Will be null if it has not yet finished.
Public propertyDateStarted Gets a DateTime that specifies the time that the task was created.
Public propertyDescription Gets a description of the task.
Public propertyHasWarnings Gets whether the task has warnings
Public propertyInitiatingUserName Gets the AppDNA username of the user that initiated the task.
Public propertyIsFinished Gets a value specifying if the server side processing has no more work to do.
Public propertyLogFile Gets a log file path, if any, associated with the current processing.
Public propertyName Gets the name of the task.
Public propertyProgress 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.
Public propertyResult Gets a string representing the result of the task.
Public propertyState Gets a value specifying the current running state of the task.
  Back to Top

Methods

 

NameDescription
Public methodDispose Immediately frees up resources held by this object.
Public methodEquals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodGetType Gets the Type of the current instance. (Inherited from Object.)
Public methodToString Returns a string that represents the current object. (Inherited from Object.)
Public methodWaitForCompletion() Waits for long running operation completes. Completion will occur regardless of success, failure or cancellation. Use a State property to detect the reason.
Public methodWaitForCompletion(TimeSpan) Waits for long running operation completes. Completion will occur regardless of success, failure or cancellation. Use a State property to detect the reason.
  Back to Top

Events

 

NameDescription
Public eventPropertyChanged Occurs when a property value changes.
  Back to Top

See Also

Reference

Citrix.SDK.AppDNA Namespace