Table of Contents

Class WorkerLoggingOffMessage

Namespace
Acuit.Pinpoint.Workstation.Messaging
Assembly
Acuit.Pinpoint.Workstation.Abstractions.dll

The message raised by the IMessenger service when a worker is logging off from the station.

public class WorkerLoggingOffMessage : WorkerStationEventMessage, IAsyncHandlingMessage, ICancelMessage
Inheritance
WorkerLoggingOffMessage
Implements
Inherited Members

Remarks

A plug-in can use this message to prevent the worker from being logged off from the station by setting Cancel to true.

This message is sent for automated (i.e., unmanned) stations as well.

Constructors

WorkerLoggingOffMessage(IWorkerAtStation, CancellationToken)

Initializes a new instance of the WorkerLoggingOffMessage class.

public WorkerLoggingOffMessage(IWorkerAtStation workerAtStation, CancellationToken cancellationToken)

Parameters

workerAtStation IWorkerAtStation

The IWorkerAtStation representing the worker at the station.

cancellationToken CancellationToken

A token that can request cancellation of asynchronous handlers.

Exceptions

ArgumentNullException

workerAtStation is null.

Properties

AsyncHandlers

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

public AsyncHandlers AsyncHandlers { get; }

Property Value

AsyncHandlers

Cancel

Gets or sets whether to cancel the worker log off.

public bool Cancel { get; set; }

Property Value

bool