Class StartProgressAction

This action is sent by the server to the client to request presenting the progress of a long running process in the UI.

public class StartProgressAction : BaseAction

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

The kind value used for this kind of action

public const string StartProgressActionKind = "startProgress"

Unique identifier specifying the kind of action to process.

public override string Kind { get; }

Optional additional progress message. Shown in the UI to describe the long running process.

public string Message { get; set; }

Progress percentage to display (value range: 0 to 100). If omitted no percentage is shown.

public double? Percentage { get; set; }

An ID that can be used in subsequent updateProgress and endProgress events to make them refer to the same progress reporting.

public string ProgressId { get; set; }

Short title of the progress reporting. Shown in the UI to describe the long running process.

public string Title { get; set; }