AppInstallOptions Class

Reference

Definition

Namespace:: Windows.ApplicationModel.Store.Preview.InstallControl

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

Provides options you can use in several method overloads of the AppInstallManager class for installing app updates.

public ref class AppInstallOptions sealed

/// [Windows.Foundation.Metadata.Activatable(393216, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 393216)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AppInstallOptions final

[Windows.Foundation.Metadata.Activatable(393216, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 393216)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AppInstallOptions

function AppInstallOptions()

Public NotInheritable Class AppInstallOptions

Inheritance: Object Platform::Object IInspectable AppInstallOptions

Attributes: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

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

Remarks

Version history

Windows version	SDK version	Value added
1809	17763	CampaignId
1809	17763	CompletedInstallToastNotificationMode
1809	17763	ExtendedCampaignId
1809	17763	InstallForAllUsers
1809	17763	InstallInProgressToastNotificationMode
1809	17763	PinToDesktopAfterInstall
1809	17763	PinToStartAfterInstall
1809	17763	PinToTaskbarAfterInstall
1809	17763	StageButDoNotInstall

Constructors

AppInstallOptions()

Creates and initializes a new instance of the AppInstallOptions class.

Properties

AllowForcedAppRestart	Gets or sets a value that indicates whether to allow a forced restart of the app that is being installed.
CampaignId	Gets or sets the promotion campaign ID that is associated with the app to install.
CatalogId	Gets or sets the catalog ID of the app to install.
CompletedInstallToastNotificationMode	Gets or sets the notification toast mode for when the app installation completes.
ExtendedCampaignId	Gets or sets the extended promotion campaign ID that is associated with the app to install.
ForceUseOfNonRemovableStorage	Gets or sets a value that indicates whether to install the app to non-removable storage even if the user has configured apps to install to SD card, or whether to install the app to non-removable storage or SD card according to the user's settings.
InstallForAllUsers	Gets or sets a value that indicates whether the application will be installed for all users.
InstallInProgressToastNotificationMode	Gets or sets the notification toast mode for when the app installation is in progress.
LaunchAfterInstall	Gets or sets a value that indicates whether to automatically launch the app after it is installed.
PinToDesktopAfterInstall	Gets or sets a value that determines whether the product being installed should be pinned to the desktop after installation is complete.
PinToStartAfterInstall	Gets or sets a value that indicates whether the product being installed should be pinned to the Start menu after installation is complete.
PinToTaskbarAfterInstall	Gets or sets a value that indicates whether the product being installed should be pinned to the taskbar after installation is complete.
Repair	Gets or sets a value that indicates whether to attempt to repair the installation of an app that is already installed.
StageButDoNotInstall	Gets or sets a value that indicates whether the installation of the app should pause after the download and staging step but not complete the final install.
TargetVolume	Gets or sets the package storage volume where the app or app bundle will be installed.

Applies to