CashDrawerCloseAlarm CashDrawerCloseAlarm CashDrawerCloseAlarm CashDrawerCloseAlarm Class

Definition

The cash drawer close alarm. Parameter defaults are provided, however the user can update them as appropriate.

public : sealed class CashDrawerCloseAlarm : ICashDrawerCloseAlarmpublic sealed class CashDrawerCloseAlarm : ICashDrawerCloseAlarmPublic NotInheritable Class CashDrawerCloseAlarm Implements ICashDrawerCloseAlarm// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

AlarmTimeout AlarmTimeout AlarmTimeout AlarmTimeout

Gets or sets the alarm timeout for the cash drawer close alarm.

public : TimeSpan AlarmTimeout { get; set; }public TimeSpan AlarmTimeout { get; set; }Public ReadWrite Property AlarmTimeout As TimeSpan// You can use this property in JavaScript.
Value
TimeSpan TimeSpan TimeSpan TimeSpan

Defines the amount of time for the alarm timeout.

BeepDelay BeepDelay BeepDelay BeepDelay

Delay between cash drawer closed alarm beeps.

public : TimeSpan BeepDelay { get; set; }public TimeSpan BeepDelay { get; set; }Public ReadWrite Property BeepDelay As TimeSpan// You can use this property in JavaScript.
Value
TimeSpan TimeSpan TimeSpan TimeSpan

Defines the amount of time between beeps.

BeepDuration BeepDuration BeepDuration BeepDuration

Duration of the cash drawer close alarm beep.

public : TimeSpan BeepDuration { get; set; }public TimeSpan BeepDuration { get; set; }Public ReadWrite Property BeepDuration As TimeSpan// You can use this property in JavaScript.
Value
TimeSpan TimeSpan TimeSpan TimeSpan

Defines the length of time the alarm beep sounds.

BeepFrequency BeepFrequency BeepFrequency BeepFrequency

Frequency of beep tone.

public : unsigned int BeepFrequency { get; set; }public uint BeepFrequency { get; set; }Public ReadWrite Property BeepFrequency As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

Defines the audio frequency of the beep tone.

Methods

StartAsync() StartAsync() StartAsync() StartAsync()

Starts the alarm countdown, returning an awaitable object that completes when the cash drawer is closed.

public : IAsyncOperation<PlatForm::Boolean> StartAsync()public IAsyncOperation<bool> StartAsync()Public Function StartAsync() As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Returns

True if the drawer has been closed; otherwise, false indicates a problem has occurred.

Events

AlarmTimeoutExpired AlarmTimeoutExpired AlarmTimeoutExpired AlarmTimeoutExpired

Event allowing the app to be notified if the alarm timeout has been triggered.

public : event TypedEventHandler AlarmTimeoutExpired<CashDrawerCloseAlarm,  object>public event TypedEventHandler AlarmTimeoutExpired<CashDrawerCloseAlarm,  object>Public Event AlarmTimeoutExpired<CashDrawerCloseAlarm,  object>// You can use this event in JavaScript.