View Source

Class InstalledPackage

Represents an installed Umbraco package with its metadata and migration status.

Inheritance

object

Namespace: Umbraco.Cms.Core.Packaging

Assembly: Umbraco.Core.dll

Syntax

[DataContract(Name = "installedPackage")]
public class InstalledPackage

Constructors

InstalledPackage()

Declaration

public InstalledPackage()

Properties

AllowPackageTelemetry

Gets or sets a value indicating whether the package allows telemetry data collection.

Declaration

[DataMember(Name = "allowPackageTelemetry")]
public bool AllowPackageTelemetry { get; set; }

Property Value

Type	Description
bool

HasMigrations

Gets a value indicating whether this package has migrations.

Declaration

[DataMember(Name = "hasMigrations")]
public bool HasMigrations { get; }

Property Value

Type	Description
bool	true if this package has migrations; otherwise, false.

HasPendingMigrations

Gets a value indicating whether this package has pending migrations.

Declaration

[DataMember(Name = "hasPendingMigrations")]
public bool HasPendingMigrations { get; }

Property Value

Type	Description
bool	true if this package has pending migrations; otherwise, false.

PackageId

Gets or sets the unique identifier of the package.

Declaration

[DataMember(Name = "id")]
public string? PackageId { get; set; }

Property Value

Type	Description
string

PackageMigrationPlans

Gets or sets the collection of migration plans associated with this package.

Declaration

[DataMember(Name = "plans")]
public IEnumerable<InstalledPackageMigrationPlans> PackageMigrationPlans { get; set; }

Property Value

Type	Description
IEnumerable<InstalledPackageMigrationPlans>

PackageName

Gets or sets the name of the package.

Declaration

[DataMember(Name = "name", IsRequired = true)]
[Required]
public string? PackageName { get; set; }

Property Value

Type	Description
string

PackageView

Gets or sets the custom view path for the package in the back office.

Declaration

[DataMember(Name = "packageView")]
public string? PackageView { get; set; }

Property Value

Type	Description
string

Version

Gets or sets the version of the installed package.

Declaration

[DataMember(Name = "version")]
public string? Version { get; set; }

Property Value

Type	Description
string