LockScreenUnlockingEventArgs Class

Reference

Definition

Namespace:: Windows.ApplicationModel.LockScreen

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Represents the lock screen unlocking events.

public ref class LockScreenUnlockingEventArgs sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class LockScreenUnlockingEventArgs final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class LockScreenUnlockingEventArgs

Public NotInheritable Class LockScreenUnlockingEventArgs

Inheritance: Object Platform::Object IInspectable LockScreenUnlockingEventArgs

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Properties

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.

Methods

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.

Applies to

Share via