Class UnitReleasedMessage

Namespace

Acuit.Pinpoint.Workstation.Messaging

Assembly

Acuit.Pinpoint.Workstation.Abstractions.dll

The message raised by the IMessenger service when a unit is released.

public class UnitReleasedMessage : UnitEventMessage, IAsyncHandlingMessage

Inheritance

object

UnitEventMessage

UnitReleasedMessage

Implements

IAsyncHandlingMessage

Inherited Members

UnitEventMessage.UnitAtStation

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

This message is sent after any workflow errors from the unit release have been processed (i.e., displayed).

Constructors

UnitReleasedMessage(IUnitAtStation, UnitReleaseStatus?, Exception?, CancellationToken)

Initializes a new instance of the UnitReleasedMessage class.

public UnitReleasedMessage(IUnitAtStation unitAtStation, UnitReleaseStatus? status, Exception? exception, CancellationToken cancellationToken)

Parameters

unitAtStation IUnitAtStation

The IUnitAtStation representing the unit at the station.

status UnitReleaseStatus

The unit release status, or null if it is not available.

exception Exception

The error that occurred when attempting to release the unit in Acuit Pinpoint, or null if no error occurred.

cancellationToken CancellationToken

A token that can request cancellation of asynchronous handlers.

Exceptions

ArgumentNullException

unitAtStation is null.

Properties

AsyncHandlers

Gets the AsyncHandlers instance to which asynchronous handlers can be added.

public AsyncHandlers AsyncHandlers { get; }

Property Value

AsyncHandlers

Exception

Gets the error that occurred when attempting to release the unit in Acuit Pinpoint, or null if no error occurred.

public Exception? Exception { get; }

Property Value

Exception

Remarks

This will not be null if the unit was not successfully released from Acuit Pinpoint, but is being released anyway as far as this workstation is concerned.

Status

Gets the unit release status, or null if it is not available.

public UnitReleaseStatus? Status { get; }

Property Value

UnitReleaseStatus

Remarks

This can be null when this is not a serialized unit station type, or when the unit is being released even though an error occurred when attempting to release it in Acuit Pinpoint.