AppInstallManager AppInstallManager AppInstallManager AppInstallManager AppInstallManager Class

Definition

Provides members for programmatically installing apps, including the ability to start an app install and get a list of app installs currently in progress.

public : sealed class AppInstallManager
struct winrt::Windows::ApplicationModel::Store::Preview::InstallControl::AppInstallManager
public sealed class AppInstallManager
Public NotInheritable Class AppInstallManager
var appInstallManager = new appInstallManager();
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
runFullTrust

Remarks

Important

Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft.

Version history

Windows version SDK version Value added
1511 10586 Cancel(String,String)
1511 10586 GetIsAppAllowedToInstallAsync(String,String,String,String)
1511 10586 Pause(String,String)
1511 10586 Restart(String,String)
1511 10586 SearchForAllUpdatesAsync(String)
1511 10586 SearchForUpdatesAsync(String,String,String,String)
1511 10586 StartAppInstallAsync(String,String,Boolean,Boolean,String,String,String)
1511 10586 UpdateAppByPackageFamilyNameAsync(String,String)
1607 14393 GetIsAppAllowedToInstallForUserAsync
1607 14393 GetIsApplicableForUserAsync
1607 14393 MoveToFrontOfDownloadQueue
1607 14393 SearchForAllUpdatesForUserAsync(User,String)
1607 14393 SearchForUpdatesForUserAsync(User,String,String,String,String)
1607 14393 StartProductInstallAsync(String,String,String,String,Boolean,Boolean,String,PackageVolume)
1607 14393 StartProductInstallForUserAsync(User,String,String,String,String,Boolean,Boolean,String,PackageVolume)
1607 14393 UpdateAppByPackageFamilyNameForUserAsync
1703 15063 AppInstallItemsWithGroupSupport
1703 15063 GetFreeDeviceEntitlementAsync
1703 15063 GetFreeUserEntitlementAsync
1703 15063 GetFreeUserEntitlementForUserAsync
1803 17134 GetIsPackageIdentityAllowedToInstallAsync
1803 17134 GetIsPackageIdentityAllowedToInstallForUserAsync
1803 17134 SearchForAllUpdatesAsync(String,String,AppUpdateOptions)
1803 17134 SearchForAllUpdatesForUserAsync(User,String,String,AppUpdateOptions)
1803 17134 SearchForUpdatesAsync(String,String,String,String,AppUpdateOptions)
1803 17134 SearchForUpdatesForUserAsync(User,String,String,String,String,AppUpdateOptions)
1803 17134 StartProductInstallAsync(String,String,String,String,AppInstallOptions)
1803 17134 StartProductInstallForUserAsync(User,String,String,String,String,AppInstallOptions)
1809 17763 CanInstallForAllUsers

Constructors

AppInstallManager() AppInstallManager() AppInstallManager() AppInstallManager() AppInstallManager()

Creates and initializes a new instance of the AppInstallManager class.

Properties

AcquisitionIdentity AcquisitionIdentity AcquisitionIdentity AcquisitionIdentity AcquisitionIdentity

Gets or sets the user identity associated with the app installs.

AppInstallItems AppInstallItems AppInstallItems AppInstallItems AppInstallItems

Retrieves information about all apps that are currently in the installation queue.

AppInstallItemsWithGroupSupport AppInstallItemsWithGroupSupport AppInstallItemsWithGroupSupport AppInstallItemsWithGroupSupport AppInstallItemsWithGroupSupport

Retrieves information about all the apps that are part of a single app bundle that is currently in the installation queue.

AutoUpdateSetting AutoUpdateSetting AutoUpdateSetting AutoUpdateSetting AutoUpdateSetting

Gets or sets the auto update setting for apps on the current computer or device.

CanInstallForAllUsers CanInstallForAllUsers CanInstallForAllUsers CanInstallForAllUsers CanInstallForAllUsers

Gets or sets a value that indicates whether the calling app has elevated administrative privileges to ensure installing an app for all users will succeed.

Methods

Cancel(String) Cancel(String) Cancel(String) Cancel(String) Cancel(String)

Cancels the installation of the specified app.

Cancel(String, String) Cancel(String, String) Cancel(String, String) Cancel(String, String) Cancel(String, String)

Cancels the installation of the specified app, with the option to generate telemetry data.

GetFreeDeviceEntitlementAsync(String, String, String) GetFreeDeviceEntitlementAsync(String, String, String) GetFreeDeviceEntitlementAsync(String, String, String) GetFreeDeviceEntitlementAsync(String, String, String) GetFreeDeviceEntitlementAsync(String, String, String)

Grants a free entitlement for the specified app to all users on the current device.

GetFreeUserEntitlementAsync(String, String, String) GetFreeUserEntitlementAsync(String, String, String) GetFreeUserEntitlementAsync(String, String, String) GetFreeUserEntitlementAsync(String, String, String) GetFreeUserEntitlementAsync(String, String, String)

Grants a free entitlement for the specified app to the current user.

GetFreeUserEntitlementForUserAsync(User, String, String, String) GetFreeUserEntitlementForUserAsync(User, String, String, String) GetFreeUserEntitlementForUserAsync(User, String, String, String) GetFreeUserEntitlementForUserAsync(User, String, String, String) GetFreeUserEntitlementForUserAsync(User, String, String, String)

Grants a free entitlement for the specified app to the specified user.

GetIsAppAllowedToInstallAsync(String) GetIsAppAllowedToInstallAsync(String) GetIsAppAllowedToInstallAsync(String) GetIsAppAllowedToInstallAsync(String) GetIsAppAllowedToInstallAsync(String)

Determines whether the specified app has permission to install on the current computer or device.

GetIsAppAllowedToInstallAsync(String, String, String, String) GetIsAppAllowedToInstallAsync(String, String, String, String) GetIsAppAllowedToInstallAsync(String, String, String, String) GetIsAppAllowedToInstallAsync(String, String, String, String) GetIsAppAllowedToInstallAsync(String, String, String, String)

Determines whether the specified app has permission to install on the current computer or device, with the option to generate telemetry data.

GetIsAppAllowedToInstallForUserAsync(User, String, String, String, String) GetIsAppAllowedToInstallForUserAsync(User, String, String, String, String) GetIsAppAllowedToInstallForUserAsync(User, String, String, String, String) GetIsAppAllowedToInstallForUserAsync(User, String, String, String, String) GetIsAppAllowedToInstallForUserAsync(User, String, String, String, String)

Determines whether the specified app has permission to install on the current computer or device for the specified user, with the option to generate telemetry data.

GetIsApplicableAsync(String, String) GetIsApplicableAsync(String, String) GetIsApplicableAsync(String, String) GetIsApplicableAsync(String, String) GetIsApplicableAsync(String, String)

Determines whether the specified app can be installed on the current computer or device.

GetIsApplicableForUserAsync(User, String, String) GetIsApplicableForUserAsync(User, String, String) GetIsApplicableForUserAsync(User, String, String) GetIsApplicableForUserAsync(User, String, String) GetIsApplicableForUserAsync(User, String, String)

Determines whether the specified app can be installed on the current computer or device for the specified user.

GetIsPackageIdentityAllowedToInstallAsync(String, String, String) GetIsPackageIdentityAllowedToInstallAsync(String, String, String) GetIsPackageIdentityAllowedToInstallAsync(String, String, String) GetIsPackageIdentityAllowedToInstallAsync(String, String, String) GetIsPackageIdentityAllowedToInstallAsync(String, String, String)

Returns a value that indicates whether the package with the specified identity info is allowed to be installed on the current device.

GetIsPackageIdentityAllowedToInstallForUserAsync(User, String, String, String) GetIsPackageIdentityAllowedToInstallForUserAsync(User, String, String, String) GetIsPackageIdentityAllowedToInstallForUserAsync(User, String, String, String) GetIsPackageIdentityAllowedToInstallForUserAsync(User, String, String, String) GetIsPackageIdentityAllowedToInstallForUserAsync(User, String, String, String)

Returns a value that indicates whether the package with the specified identity info is allowed to be installed on the current device for the specified user.

IsStoreBlockedByPolicyAsync(String, String) IsStoreBlockedByPolicyAsync(String, String) IsStoreBlockedByPolicyAsync(String, String) IsStoreBlockedByPolicyAsync(String, String) IsStoreBlockedByPolicyAsync(String, String)

Determines whether the specified app is blocked by policy on the current computer or device.

MoveToFrontOfDownloadQueue(String, String) MoveToFrontOfDownloadQueue(String, String) MoveToFrontOfDownloadQueue(String, String) MoveToFrontOfDownloadQueue(String, String) MoveToFrontOfDownloadQueue(String, String)

Moves the specified app to the front of the download queue.

Pause(String) Pause(String) Pause(String) Pause(String) Pause(String)

Pauses the installation of the specified app.

Pause(String, String) Pause(String, String) Pause(String, String) Pause(String, String) Pause(String, String)

Pauses the installation of the specified app, with the option to generate telemetry data.

Restart(String) Restart(String) Restart(String) Restart(String) Restart(String)

Restarts the installation of the specified app.

Restart(String, String) Restart(String, String) Restart(String, String) Restart(String, String) Restart(String, String)

Restarts the installation of the specified app, with the option to generate telemetry data.

SearchForAllUpdatesAsync() SearchForAllUpdatesAsync() SearchForAllUpdatesAsync() SearchForAllUpdatesAsync() SearchForAllUpdatesAsync()

Searches for all available updates to apps installed on the current computer or device.

SearchForAllUpdatesAsync(String) SearchForAllUpdatesAsync(String) SearchForAllUpdatesAsync(String) SearchForAllUpdatesAsync(String) SearchForAllUpdatesAsync(String)

Searches for all available updates to apps installed on the current computer or device, with the option to generate telemetry data.

SearchForAllUpdatesAsync(String, String, AppUpdateOptions) SearchForAllUpdatesAsync(String, String, AppUpdateOptions) SearchForAllUpdatesAsync(String, String, AppUpdateOptions) SearchForAllUpdatesAsync(String, String, AppUpdateOptions) SearchForAllUpdatesAsync(String, String, AppUpdateOptions)

Searches for all available updates to apps installed on the current computer or device, with the ability to allow forced app restarts and the option to generate telemetry data.

SearchForAllUpdatesForUserAsync(User, String) SearchForAllUpdatesForUserAsync(User, String) SearchForAllUpdatesForUserAsync(User, String) SearchForAllUpdatesForUserAsync(User, String) SearchForAllUpdatesForUserAsync(User, String)

Searches for all available updates to apps installed on the current computer or device for the specified user, with the option to generate telemetry data.

SearchForAllUpdatesForUserAsync(User, String, String, AppUpdateOptions) SearchForAllUpdatesForUserAsync(User, String, String, AppUpdateOptions) SearchForAllUpdatesForUserAsync(User, String, String, AppUpdateOptions) SearchForAllUpdatesForUserAsync(User, String, String, AppUpdateOptions) SearchForAllUpdatesForUserAsync(User, String, String, AppUpdateOptions)

Searches for all available updates to apps installed on the current computer or device for the specified user, with the ability to allow forced app restarts and the option to generate telemetry data.

SearchForUpdatesAsync(String, String) SearchForUpdatesAsync(String, String) SearchForUpdatesAsync(String, String) SearchForUpdatesAsync(String, String) SearchForUpdatesAsync(String, String)

Searches for updates for the specified app.

SearchForUpdatesAsync(String, String, String, String) SearchForUpdatesAsync(String, String, String, String) SearchForUpdatesAsync(String, String, String, String) SearchForUpdatesAsync(String, String, String, String) SearchForUpdatesAsync(String, String, String, String)

Searches for updates for the specified app, with the option to generate telemetry data.

SearchForUpdatesAsync(String, String, String, String, AppUpdateOptions) SearchForUpdatesAsync(String, String, String, String, AppUpdateOptions) SearchForUpdatesAsync(String, String, String, String, AppUpdateOptions) SearchForUpdatesAsync(String, String, String, String, AppUpdateOptions) SearchForUpdatesAsync(String, String, String, String, AppUpdateOptions)

Searches for updates for the specified app, with the ability to allow a forced app restart and the option to generate telemetry data.

SearchForUpdatesForUserAsync(User, String, String, String, String) SearchForUpdatesForUserAsync(User, String, String, String, String) SearchForUpdatesForUserAsync(User, String, String, String, String) SearchForUpdatesForUserAsync(User, String, String, String, String) SearchForUpdatesForUserAsync(User, String, String, String, String)

Searches for updates for the specified app and user, with the option to generate telemetry data.

SearchForUpdatesForUserAsync(User, String, String, String, String, AppUpdateOptions) SearchForUpdatesForUserAsync(User, String, String, String, String, AppUpdateOptions) SearchForUpdatesForUserAsync(User, String, String, String, String, AppUpdateOptions) SearchForUpdatesForUserAsync(User, String, String, String, String, AppUpdateOptions) SearchForUpdatesForUserAsync(User, String, String, String, String, AppUpdateOptions)

Searches for updates for the specified app and user, with the ability to allow a forced app restart and the option to generate telemetry data.

StartAppInstallAsync(String, String, Boolean, Boolean) StartAppInstallAsync(String, String, Boolean, Boolean) StartAppInstallAsync(String, String, Boolean, Boolean) StartAppInstallAsync(String, String, Boolean, Boolean) StartAppInstallAsync(String, String, Boolean, Boolean)

Starts the installation of the specified app.

StartAppInstallAsync(String, String, Boolean, Boolean, String, String, String) StartAppInstallAsync(String, String, Boolean, Boolean, String, String, String) StartAppInstallAsync(String, String, Boolean, Boolean, String, String, String) StartAppInstallAsync(String, String, Boolean, Boolean, String, String, String) StartAppInstallAsync(String, String, Boolean, Boolean, String, String, String)

Starts the installation of the specified app, with the option to generate telemetry data.

StartProductInstallAsync(String, String, String, String, Boolean, Boolean, String, PackageVolume) StartProductInstallAsync(String, String, String, String, Boolean, Boolean, String, PackageVolume) StartProductInstallAsync(String, String, String, String, Boolean, Boolean, String, PackageVolume) StartProductInstallAsync(String, String, String, String, Boolean, Boolean, String, PackageVolume) 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) StartProductInstallAsync(String, String, String, String, AppInstallOptions) StartProductInstallAsync(String, String, String, String, AppInstallOptions) StartProductInstallAsync(String, String, String, String, AppInstallOptions) 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.

StartProductInstallForUserAsync(User, String, String, String, String, Boolean, Boolean, String, PackageVolume) StartProductInstallForUserAsync(User, String, String, String, String, Boolean, Boolean, String, PackageVolume) StartProductInstallForUserAsync(User, String, String, String, String, Boolean, Boolean, String, PackageVolume) StartProductInstallForUserAsync(User, String, String, String, String, Boolean, Boolean, String, PackageVolume) StartProductInstallForUserAsync(User, String, String, String, String, Boolean, Boolean, String, PackageVolume)

Starts the installation of the specified app or app bundle for the specified user.

StartProductInstallForUserAsync(User, String, String, String, String, AppInstallOptions) StartProductInstallForUserAsync(User, String, String, String, String, AppInstallOptions) StartProductInstallForUserAsync(User, String, String, String, String, AppInstallOptions) StartProductInstallForUserAsync(User, String, String, String, String, AppInstallOptions) StartProductInstallForUserAsync(User, String, String, String, String, AppInstallOptions)

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

UpdateAppByPackageFamilyNameAsync(String) UpdateAppByPackageFamilyNameAsync(String) UpdateAppByPackageFamilyNameAsync(String) UpdateAppByPackageFamilyNameAsync(String) UpdateAppByPackageFamilyNameAsync(String)

Starts the update of an app specified by the package family name.

UpdateAppByPackageFamilyNameAsync(String, String) UpdateAppByPackageFamilyNameAsync(String, String) UpdateAppByPackageFamilyNameAsync(String, String) UpdateAppByPackageFamilyNameAsync(String, String) UpdateAppByPackageFamilyNameAsync(String, String)

Starts the update of an app specified by the package family name, with the option to generate telemetry data.

UpdateAppByPackageFamilyNameForUserAsync(User, String, String) UpdateAppByPackageFamilyNameForUserAsync(User, String, String) UpdateAppByPackageFamilyNameForUserAsync(User, String, String) UpdateAppByPackageFamilyNameForUserAsync(User, String, String) UpdateAppByPackageFamilyNameForUserAsync(User, String, String)

Starts the update of an app for a given user specified by the package family name, with the option to generate telemetry data.

Events

ItemCompleted ItemCompleted ItemCompleted ItemCompleted ItemCompleted

Occurs when an app has finished installing.

ItemStatusChanged ItemStatusChanged ItemStatusChanged ItemStatusChanged ItemStatusChanged

Occurs when the status of an app in the installation queue has changed.