Class PushWorkstationStatus

Namespace

Acuit.Pinpoint.Workflows.Workstation.Activities

Assembly

Acuit.Pinpoint.Workflows.Workstation.dll

An activity that sets the workstation status message while it executes a child activity.

public class PushWorkstationStatus : Activity, IActivity

Inheritance

object

Activity

PushWorkstationStatus

Implements

IActivity

Inherited Members

Activity.DisplayName

Activity.Parameters

Activity.Variables

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Remarks

This will set the status message (if specified) and then execute the Body activity. When the Body activity completes, the status message will be removed, restoring whatever workstation status was originally active. The SetWorkstationStatus activity can be used within the Body activity to change the message while the activity executes.

This activity requires the IWorkstationStatusManager service (automatically provided by Acuit Pinpoint Workstation). It provides an IWorkstationStatus service to the child Body activity.

Properties

Body

Gets or sets the optional child activity to execute.

public IActivity Body { get; set; }

Property Value

IActivity

Message

Gets or sets the message. Is this is not specified, then the active message will not be changed and SetWorkstationStatus should be used within Body to set the message.

public ValueSource<string> Message { get; set; }

Property Value

ValueSource<string>

Methods

OnExecuteAsync(ActivityContext, CancellationToken)

Derived classes must implement this to perform the activity.

protected override Task OnExecuteAsync(ActivityContext context, CancellationToken cancellationToken)

Parameters

context ActivityContext

The activity context.

cancellationToken CancellationToken

The cancellation token used to request canceling the activity.

Returns

Task

A task that represents the asynchronous operation.

Exceptions

ArgumentNullException

context is null.

InvalidOperationException

A service required by the activity is not available, or a required activity property value is not set. This will only occur asynchronously, wrapped in an AggregateException as the faulted task's Exception.

Exception

An error occurred while performing the activity. This will only occur asynchronously, wrapped in an AggregateException as the faulted task's Exception.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Remarks

This is expected to produce a string suitable for labeling this activity in a workflow diagram. It should be as specific as possible, but while keeping it very short. In general, it should be the short name of the class (as that is how it would typically be defined in the workflow XAML), optionally followed by other property values of interest in a diagram. The default implementation returns the short name of the class.