Share via

AppInstallManager.StartProductInstallAsync Method

  • Reference

Definition

Namespace:
Windows.ApplicationModel.Store.Preview.InstallControl

Overloads

StartProductInstallAsync(String, String, String, String, AppInstallOptions)

Starts the installation of the specified app or app bundle, with the ability to specify additional install options such as whether to allow a forced app restart.
StartProductInstallAsync(String, String, String, String, Boolean, Boolean, String, PackageVolume)

Starts the installation of the specified app or app bundle.

StartProductInstallAsync(String, String, String, String, AppInstallOptions)

Edit

Starts the installation of the specified app or app bundle, with the ability to specify additional install options such as whether to allow a forced app restart.

public:
 virtual IAsyncOperation<IVectorView<AppInstallItem ^> ^> ^ StartProductInstallAsync(Platform::String ^ productId, Platform::String ^ flightId, Platform::String ^ clientId, Platform::String ^ correlationVector, AppInstallOptions ^ installOptions) = StartProductInstallAsync;
/// [Windows.Foundation.Metadata.Overload("StartProductInstallWithOptionsAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVectorView<AppInstallItem>> StartProductInstallAsync(winrt::hstring const& productId, winrt::hstring const& flightId, winrt::hstring const& clientId, winrt::hstring const& correlationVector, AppInstallOptions const& installOptions);
[Windows.Foundation.Metadata.Overload("StartProductInstallWithOptionsAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<AppInstallItem>> StartProductInstallAsync(string productId, string flightId, string clientId, string correlationVector, AppInstallOptions installOptions);
function startProductInstallAsync(productId, flightId, clientId, correlationVector, installOptions)
Public Function StartProductInstallAsync (productId As String, flightId As String, clientId As String, correlationVector As String, installOptions As AppInstallOptions) As IAsyncOperation(Of IReadOnlyList(Of AppInstallItem))

Parameters

productId
String

Platform::String

winrt::hstring

The product ID of the app to install.

flightId
String

Platform::String

winrt::hstring

The flight ID of the app to install.

clientId
String

Platform::String

winrt::hstring

The ID of the caller.

correlationVector
String

Platform::String

winrt::hstring

A correlation vector string that can be used to generate telemetry data.

installOptions
AppInstallOptions

Provides additional options for the operation, including the ability to allow a forced app restart.

Returns

IAsyncOperation<IVectorView<AppInstallItem>>

IAsyncOperation<IReadOnlyList<AppInstallItem>>

An asynchronous operation that, on successful completion, returns the app or set of apps (for an app bundle) that were added to the installation queue. If you use Asynchronous programming, the result type is a read-only list/vector of AppInstallItem items. (You can use APIs of IVectorView<AppInstallItem> for C++ or JavaScript, APIs of IReadOnlyList<AppInstallItem> for .NET.)

Attributes
OverloadAttribute RemoteAsyncAttribute

Windows requirements

Device family
Windows 10, version 1803 (introduced in 10.0.17134.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v6.0)
App capabilities
runFullTrust

Applies to

StartProductInstallAsync(String, String, String, String, Boolean, Boolean, String, PackageVolume)

Edit

Starts the installation of the specified app or app bundle.

public:
 virtual IAsyncOperation<IVectorView<AppInstallItem ^> ^> ^ StartProductInstallAsync(Platform::String ^ productId, Platform::String ^ catalogId, Platform::String ^ flightId, Platform::String ^ clientId, bool repair, bool forceUseOfNonRemovableStorage, Platform::String ^ correlationVector, PackageVolume ^ targetVolume) = StartProductInstallAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVectorView<AppInstallItem>> StartProductInstallAsync(winrt::hstring const& productId, winrt::hstring const& catalogId, winrt::hstring const& flightId, winrt::hstring const& clientId, bool const& repair, bool const& forceUseOfNonRemovableStorage, winrt::hstring const& correlationVector, PackageVolume const& targetVolume);
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<AppInstallItem>> StartProductInstallAsync(string productId, string catalogId, string flightId, string clientId, bool repair, bool forceUseOfNonRemovableStorage, string correlationVector, PackageVolume targetVolume);
function startProductInstallAsync(productId, catalogId, flightId, clientId, repair, forceUseOfNonRemovableStorage, correlationVector, targetVolume)
Public Function StartProductInstallAsync (productId As String, catalogId As String, flightId As String, clientId As String, repair As Boolean, forceUseOfNonRemovableStorage As Boolean, correlationVector As String, targetVolume As PackageVolume) As IAsyncOperation(Of IReadOnlyList(Of AppInstallItem))

Parameters

productId
String

Platform::String

winrt::hstring

The product ID of the app to install.

catalogId
String

Platform::String

winrt::hstring

The catalog ID of the app to install.

flightId
String

Platform::String

winrt::hstring

The flight ID of the app to install.

clientId
String

Platform::String

winrt::hstring

The ID of the caller.

repair
Boolean

bool

True to attempt to repair the installation of an app that is already installed; otherwise, false.

forceUseOfNonRemovableStorage
Boolean

bool

True to install the app to non-removable storage even if the user has configured apps to install to SD card; false to install the app to non-removable storage or SD card according to the user's settings.

correlationVector
String

Platform::String

winrt::hstring

A correlation vector string that can be used to generate telemetry data.

targetVolume
PackageVolume

The package storage volume where the app or app bundle will be installed.

Returns

IAsyncOperation<IVectorView<AppInstallItem>>

IAsyncOperation<IReadOnlyList<AppInstallItem>>

An asynchronous operation that, on successful completion, returns the app or set of apps (for an app bundle) that were added to the installation queue. If you use Asynchronous programming, the result type is a read-only list/vector of AppInstallItem items. (You can use APIs of IVectorView<AppInstallItem> for C++ or JavaScript, APIs of IReadOnlyList<AppInstallItem> for .NET.)

Attributes
RemoteAsyncAttribute

Windows requirements

Device family
Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v3.0)
App capabilities
runFullTrust

Applies to