LockScreenUnlockingDeferral 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 an unlock deferral. 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 ref class LockScreenUnlockingDeferral sealed

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

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

Public NotInheritable Class LockScreenUnlockingDeferral

Inheritance: Object Platform::Object IInspectable LockScreenUnlockingDeferral

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)

Methods

Complete()

Notifies the system that your deferral is complete. If your deferral takes too long to complete, your lock screen app will be terminated by the system and potentially removed as the user’s default lock app.

Applies to