Share via


LongRunningOperationStatus Members

Include Protected Members
Include Inherited Members

Returns the status of the job that is currently running.

The LongRunningOperationStatus type exposes the following members.

Properties

  Name Description
Public property ErrorsEncountered An XML string that contains a list of all errors encountered. There is no fixed format for errors.
Public property GearsImageUrl Image that should be used on the progress page. If this property is empty, the default gears image will be used.
Public property HasTimedOut Returns whether this job has timed out.
Public property IsActive Returns whether the job currently running is active.
Public property JobId ID of the job that is currently running.
Public property LastUpdated Returns the time, in Coordinated Universal Time (UTC) format, when the status of this long running operation was last updated.
Public property NavigateWhenDoneUrl URL to navigate to after successful completion of job. Navigation may occur automatically or may require that the user clicks OK, depending on the value that has been set on the RedirectWhenFinished property.
Public property OperationsPerformed A value that represents the total number of operations that can be performed. For example, if x of y operations can be performed, this value is y, or the total number of operations.
Public property OriginalJobId Original ID of the job that has been retried. The PreviousJobId points to the job that ran immediately before this job and failed, while the OriginalJobId points to the job that originated the process.
Public property PreviousJobId ID of the job that ran previously and failed (if this job has been retried).
Public property RedirectWhenFinished If this value is true, redirects to the specified URL when the task is finished.
Public property RetryInformation
Public property Retryhref URL that should be navigated to if a failure occurs. This navigation is not automatic and requires the user to click the "Retry" button.
Public property ShouldBePurged
Public property Started Time, in Coordinated Universal Time (UTC) format, when this long running operation was started.
Public property Status Returns current job status.
Public property StatusAsString Returns current job status as a string.
Public property StatusDescription Returns description of job status.
Public property SuccessesEncountered List of success events that have been encountered during this operation.
Public property Title Returns the name of the long running operation that was initiated.
Public property TotalOperationsToBePerformed A value that represents the total number of operations that can be performed. For example, if x of y operations can be performed, this value is y, or the total number of operations.
Public property TypeOfOperation Specifies the type of operation (move, copy, delete, spawn, or generic), for easy retrieval by type.
Public property UserCanCancel User can cancel the job that is currently running.
Public property UserId Name of the user who initiated this job.
Public property UserRequestedCancel Boolean value that specifies whether the user requested that the job be cancelled.
Public property WaitMessage Wait message displayed to the user.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public methodStatic member GetAllJobs Get a LongRunningOperationStatus for each of the entries in the root Web site's long running operation status list.
Public methodStatic member GetAllJobsForCurrentUser Used to determine if there are jobs initiated by a user that were terminated due to system (or other) failures.
Public method GetHashCode (Inherited from Object.)
Public methodStatic member GetJob Instantiates a new LongRunningOperationStatus list and populates it with the most current status information.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public methodStatic member PurgeOldEntries Removes old status bucket entries from the LongRunningOperationStatus list at the root Web site.
Public method Remove Removes status information about this particular job from the database.
Public method RequestCancel Requests cancellation of the job that is currently running.
Public method ToString (Inherited from Object.)

Top

See Also

Reference

LongRunningOperationStatus Class

Microsoft.SharePoint.Publishing Namespace