Class SetUnitBuyoffMessage
- Namespace
- Acuit.Pinpoint.Workstation.Messaging
- Assembly
- Acuit.Pinpoint.Workstation.Abstractions.dll
The message raised by the IMessenger service when the operator clicks a buyoff button for a buyoff that is not currently set.
public class SetUnitBuyoffMessage : ChangeUnitBuyoffMessage, IWorkstationRequestMessage
- Inheritance
-
SetUnitBuyoffMessage
- Implements
- Inherited Members
Remarks
By default, Acuit Pinpoint Workstation will handle this message when a unit is at the station by setting the unit buyoff via SetBuyoff(string), displaying an error message if the operation fails. If no unit is at the station, Acuit Pinpoint Workstation will ignore this message.
If the buyoff was successfully set, the message Response will contain the resulting UnitBuyoff; otherwise, it will contain null.
A plug-in can customize the default behavior by registering a recipient for this message. To suppress the default behavior, the plug-in should use Reply(T) to set the response to the message.
A plug-in can emulate the operator action that this message represents by sending this message.
Constructors
SetUnitBuyoffMessage(string)
Initializes a new instance of the SetUnitBuyoffMessage class.
public SetUnitBuyoffMessage(string buyoffName)
Parameters
buyoffNamestringThe buyoff name.
Exceptions
- ArgumentNullException
buyoffNameis null.