LockScreenManager.RequestAccessAsync method

  • Article

Sets the current app as the lock screen background provider.

Syntax

public static IAsyncOperation<LockScreenRequestResult> RequestAccessAsync()

Public Shared Function RequestAccessAsync() As IAsyncOperation(Of LockScreenRequestResult)

public:
static IAsyncOperation<LockScreenRequestResult>^ RequestAccessAsync()

Parameters

This method has no parameters.

Return value

Type: IAsyncOperation<LockScreenRequestResult>

The result of the asynchronous operation. Indicates if the app was successfully or unsuccessfully set as the lock screen background provider.

Remarks

If the app is not the current lock screen background provider at the time it calls the RequestAccessAsync method, the shell displays a dialog box to the user and gives the user the ability to accept or deny the change.

This method must be called while the app is running in the foreground. It cannot be called from a background agent.

Requirements

Minimum supported client

None supported

Minimum supported server

None supported

Minimum supported phone

Windows Phone 8

Namespace

Windows.Phone.System.UserProfile Windows::Phone::System::UserProfile [C++]

Metadata

 Windows.WinMD

See also

LockScreenManager