AppInstallManager Class
Definition
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.
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 ref class AppInstallManager sealed/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class AppInstallManager final/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class AppInstallManager final[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class AppInstallManager[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class AppInstallManagerfunction AppInstallManager()Public NotInheritable Class AppInstallManager- Inheritance
- Attributes
Windows requirements
| Device family |
Windows 10 (introduced in 10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v1.0)
|
| App 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() |
Creates and initializes a new instance of the AppInstallManager class. |
Properties
| AcquisitionIdentity |
Gets or sets the user identity associated with the app installs. |
| AppInstallItems |
Retrieves information about all apps that are currently in the installation queue. |
| AppInstallItemsWithGroupSupport |
Retrieves information about all the apps that are part of a single app bundle that is currently in the installation queue. |
| AutoUpdateSetting |
Gets or sets the auto update setting for apps on the current computer or device. |
| 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) |
Cancels the installation of the specified app. |
| Cancel(String, String) |
Cancels the installation of the specified app, with the option to generate telemetry data. |
| GetFreeDeviceEntitlementAsync(String, String, String) |
Grants a free entitlement for the specified app to all users on the current device. |
| GetFreeUserEntitlementAsync(String, String, String) |
Grants a free entitlement for the specified app to the current user. |
| GetFreeUserEntitlementForUserAsync(User, String, String, String) |
Grants a free entitlement for the specified app to the specified user. |
| GetIsAppAllowedToInstallAsync(String) |
Determines whether the specified app has permission to install on the current computer or device. |
| 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) |
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) |
Determines whether the specified app can be installed on the current computer or device. |
| 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) |
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) |
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) |
Determines whether the specified app is blocked by policy on the current computer or device. |
| MoveToFrontOfDownloadQueue(String, String) |
Moves the specified app to the front of the download queue. |
| Pause(String) |
Pauses the installation of the specified app. |
| Pause(String, String) |
Pauses the installation of the specified app, with the option to generate telemetry data. |
| Restart(String) |
Restarts the installation of the specified app. |
| Restart(String, String) |
Restarts the installation of the specified app, with the option to generate telemetry data. |
| SearchForAllUpdatesAsync() |
Searches for all available updates to apps installed on the current computer or device. |
| 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) |
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) |
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) |
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) |
Searches for updates for the specified app. |
| 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) |
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) |
Searches for updates for the specified app and user, with the option to generate telemetry data. |
| 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) |
Starts the installation of the specified app. |
| 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, 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. |
| 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. |
| StartProductInstallForUserAsync(User, String, String, String, String, Boolean, Boolean, String, PackageVolume) |
Starts the installation of the specified app or app bundle for the specified user. |
| UpdateAppByPackageFamilyNameAsync(String) |
Starts the update of an app specified by the package family name. |
| 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) |
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 |
Occurs when an app has finished installing. |
| ItemStatusChanged |
Occurs when the status of an app in the installation queue has changed. |
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for