BackgroundExecutionManager.RequestAccessKindAsync Method

Reference

Definition

Namespace:: Windows.ApplicationModel.Background

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

Prompts the user whether they consent to allow the app to perform the specified level of background activity in the background. On the Desktop OS Edition this may present a prompt to the user for their consent.

public:
 static IAsyncOperation<bool> ^ RequestAccessKindAsync(BackgroundAccessRequestKind requestedAccess, Platform::String ^ reason);

/// [Windows.Foundation.Metadata.Overload("RequestAccessKindAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
 static IAsyncOperation<bool> RequestAccessKindAsync(BackgroundAccessRequestKind const& requestedAccess, winrt::hstring const& reason);

[Windows.Foundation.Metadata.Overload("RequestAccessKindAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public static IAsyncOperation<bool> RequestAccessKindAsync(BackgroundAccessRequestKind requestedAccess, string reason);

function requestAccessKindAsync(requestedAccess, reason)

Public Shared Function RequestAccessKindAsync (requestedAccess As BackgroundAccessRequestKind, reason As String) As IAsyncOperation(Of Boolean)

Parameters

requestedAccess: BackgroundAccessRequestKind

The type of background activity the app wishes to perform.

reason: String
Platform::String

winrt::hstring

The string to display in the prompt that the system will raise to the user to describe why the app is requesting to run in the background. For example, the string that appears after "The app says:"

Prompt to run in the background