LockScreenUnlockingEventArgs LockScreenUnlockingEventArgs LockScreenUnlockingEventArgs LockScreenUnlockingEventArgs Class

Definition

Represents the lock screen unlocking events.

public : sealed class LockScreenUnlockingEventArgs : ILockScreenUnlockingEventArgspublic sealed class LockScreenUnlockingEventArgs : ILockScreenUnlockingEventArgsPublic NotInheritable Class LockScreenUnlockingEventArgs Implements ILockScreenUnlockingEventArgs// 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

Deadline Deadline Deadline Deadline

Gets the deadline by which the lock screen app must unlock the device. If your unlocking deferral takes too long, your lock screen app will be terminated by the system and potentially removed as the user’s default lock app.

public : DateTime Deadline { get; }public DateTimeOffset Deadline { get; }Public ReadOnly Property Deadline As DateTimeOffset// You can use this property in JavaScript.
Value
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

The deadline by which your app must unlock the device.

Methods

GetDeferral() GetDeferral() GetDeferral() GetDeferral()

Gets a LockScreenUnlockingDeferral, which defers the unlocking of the device. To show an unlock animation, your lock screen app must:

  • Register to be notified of unlocking via the Unlocking event.
  • In the Unlocking event handler, call GetDeferral.
  • Kick off an animation. + When that animation completes, call Complete on the deferral to end the deferral.
    • Note: If the animation takes too long, your lock screen app will be terminated by the system and potentially removed as the user’s default lock app.
public : LockScreenUnlockingDeferral GetDeferral()public LockScreenUnlockingDeferral GetDeferral()Public Function GetDeferral() As LockScreenUnlockingDeferral// You can use this method in JavaScript.
Returns