AppInstallItem Class

Definition

Namespace:

Windows.ApplicationModel.Store.Preview.InstallControl

Represents an app that is in the installation queue.

public ref class AppInstallItem sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class AppInstallItem final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class AppInstallItem

Public NotInheritable Class AppInstallItem

Inheritance

Object Platform::Object IInspectable AppInstallItem

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

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

Use the AppInstallManager.AppInstallItems property to retrieve a vector view of AppInstallItem objects.

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)
1511	10586	Pause(String)
1511	10586	Restart(String)
1703	15063	Children
1703	15063	ItemOperationsMightAffectOtherItems
1803	17134	LaunchAfterInstall
1809	17763	CompletedInstallToastNotificationMode
1809	17763	InstallInProgressToastNotificationMode
1809	17763	PinToDesktopAfterInstall
1809	17763	PinToStartAfterInstall
1809	17763	PinToTaskbarAfterInstall

Properties

Children	Retrieves information about app installs that are children of the current app install. This property only returns a value if the current app install is the parent of other app installs that are part of a the same app bundle.
CompletedInstallToastNotificationMode	Gets or sets the notification toast mode for when the app installation completes.
InstallInProgressToastNotificationMode	Gets or sets the notification toast mode for when the app installation is in progress.
InstallType	Gets the type of the current app install.
IsUserInitiated	Indicates whether the current app install was initiated by the user.
ItemOperationsMightAffectOtherItems	Indicates whether the current app install is part of an app bundle, and therefore pausing or canceling the app install might affect other items in the installation queue.
LaunchAfterInstall	Gets a value that indicates whether the app that is in the installation queue will be automatically launched after it is installed.
PackageFamilyName	Gets the package family name for the current app.
PinToDesktopAfterInstall	Gets or sets a value that indicates 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.
ProductId	Gets the product ID for the current app.

Methods

Cancel()	Cancels the installation of the current app.
Cancel(String)	Cancels the installation of the current app, with the option to generate telemetry data.
GetCurrentStatus()	Gets the installation status of the current app.
Pause()	Pauses the installation of the current app.
Pause(String)	Pauses the installation of the current app, with the option to generate telemetry data.
Restart()	Restarts the installation of the current app.
Restart(String)	Restarts the installation of the current app, with the option to generate telemetry data.

Events

Completed	Occurs when the installation of the current app has finished.
StatusChanged	Occurs when the installation status of the current app has changed.