AddPackageOptions Class

Definition

Specifies the deployment options that you can configure when you use the AddPackageByUriAsync method to add a package, package manifest, or App Installer file.

public ref class AddPackageOptions sealed
/// [Windows.Foundation.Metadata.Activatable(655360, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 655360)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class AddPackageOptions final
[Windows.Foundation.Metadata.Activatable(655360, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 655360)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class AddPackageOptions
function AddPackageOptions()
Public NotInheritable Class AddPackageOptions
Inheritance
Object Platform::Object IInspectable AddPackageOptions
Attributes

Windows requirements

Device family
Windows 10, version 2004 (introduced in 10.0.19041.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v10.0)

Remarks

You can pass an initialized instance of this class to the options parameter of the AddPackageByUriAsync method.

Constructors

AddPackageOptions()

Creates a new instance of the AddPackageOptions class.

Properties

AllowUnsigned

Gets or sets a value that indicates whether to allow an unsigned package to be added.

DeferRegistrationWhenPackagesAreInUse

Gets or sets a value that indicates whether to delay registration of the main package or dependency packages if the packages are currently in use.

DependencyPackageUris

Gets the list of URIs of the dependency packages to add.

DeveloperMode

Gets or sets a value that indicates whether the app is installed in developer mode.

ExpectedDigests

Gets a dictionary that maps the URIs associated with an AddPackageOptions with the corresponding digest string.

ExternalLocationUri

Gets or sets the URI of an external disk location outside of the MSIX package where the package manifest can reference application content.

ForceAppShutdown

Gets or sets a value that indicates whether the processes associated with the package will be shut down forcibly so that registration can continue if the package, or any package that depends on the package, is currently in use.

ForceTargetAppShutdown

Gets or sets a value that indicates whether the processes associated with the package will be shut down forcibly so that registration can continue if the package is currently in use.

ForceUpdateFromAnyVersion

Gets or sets a value that indicates whether to force a specific version of a package to be added, regardless of if a higher version is already added.

InstallAllResources

Gets or sets a value that indicates whether the app skips resource applicability checks. This effectively stages or registers all resource packages that a user passes in to the command, which forces applicability for all packages contained in a bundle. If a user passes in a bundle, all contained resource packages will be registered.

LimitToExistingPackages

Gets or sets a value indicating whether missing referenced packages should be downloaded.

OptionalPackageFamilyNames

Gets the list of package family names from the main bundle to be added.

OptionalPackageUris

Gets the list of URIs of related optional packages to be updated to the same version as the new optional packages.

RelatedPackageUris

Gets the list of URIs of related optional packages to be updated to the same version as the new optional packages.

RequiredContentGroupOnly

Gets or sets a value that indicates whether only the required content group will be added. An app can be installed as a package with the required content group alone.

RetainFilesOnFailure

Gets or sets a value that indicates whether to remove files that have been created on the target machine during the install process in the case of a failed deployment.

StageInPlace

Gets or sets a value that indicates whether to stage the package in place.

StubPackageOption

Gets or sets the stub options for the package.

TargetVolume

Gets or sets the volume to which the package is added.

Applies to

See also