Class PackageDefinition

A created package in the back office.

Inheritance

object

Namespace: Umbraco.Cms.Core.Packaging

Assembly: Umbraco.Core.dll

Syntax

[DataContract(Name = "packageInstance")]
public class PackageDefinition

Remarks

This data structure is persisted to createdPackages.config when creating packages in the back office.

Constructors

View Source

PackageDefinition()

Declaration

public PackageDefinition()

Properties

View Source

ContentLoadChildNodes

Gets or sets a value indicating whether child content nodes should be loaded.

Declaration

[DataMember(Name = "contentLoadChildNodes")]
public bool ContentLoadChildNodes { get; set; }

Property Value

Type	Description
bool

View Source

ContentNodeId

Gets or sets the content node identifier to include in the package.

Declaration

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

Property Value

Type	Description
string

View Source

DataTypes

Gets or sets the collection of data type identifiers included in this package.

Declaration

[DataMember(Name = "dataTypes")]
public IList<string> DataTypes { get; set; }

Property Value

Type	Description
IList<string>

View Source

DictionaryItems

Gets or sets the collection of dictionary item identifiers included in this package.

Declaration

[DataMember(Name = "dictionaryItems")]
public IList<string> DictionaryItems { get; set; }

Property Value

Type	Description
IList<string>

View Source

DocumentTypes

Gets or sets the collection of document type identifiers included in this package.

Declaration

[DataMember(Name = "documentTypes")]
public IList<string> DocumentTypes { get; set; }

Property Value

Type	Description
IList<string>

View Source

Id

Gets or sets the unique identifier for this package definition.

Declaration

[DataMember(Name = "id")]
public int Id { get; set; }

Property Value

Type	Description
int

View Source

Languages

Gets or sets the collection of language identifiers included in this package.

Declaration

[DataMember(Name = "languages")]
public IList<string> Languages { get; set; }

Property Value

Type	Description
IList<string>

View Source

MediaLoadChildNodes

Gets or sets a value indicating whether child media nodes should be loaded.

Declaration

[DataMember(Name = "mediaLoadChildNodes")]
public bool MediaLoadChildNodes { get; set; }

Property Value

Type	Description
bool

View Source

MediaTypes

Gets or sets the collection of media type identifiers included in this package.

Declaration

[DataMember(Name = "mediaTypes")]
public IList<string> MediaTypes { get; set; }

Property Value

Type	Description
IList<string>

View Source

MediaUdis

Gets or sets the collection of media UDIs included in this package.

Declaration

[DataMember(Name = "mediaUdis")]
public IList<GuidUdi> MediaUdis { get; set; }

Property Value

Type	Description
IList<GuidUdi>

View Source

Name

Gets or sets the name of the package.

Declaration

[DataMember(Name = "name")]
[Required]
public string Name { get; set; }

Property Value

Type	Description
string

View Source

PackageId

Gets or sets the globally unique identifier for this package.

Declaration

[DataMember(Name = "packageGuid")]
public Guid PackageId { get; set; }

Property Value

Type	Description
Guid

View Source

PackagePath

The full path to the package's XML file.

Declaration

[DataMember(Name = "packagePath")]
public string PackagePath { get; set; }

Property Value

Type	Description
string

View Source

PartialViews

Gets or sets the collection of partial view paths included in this package.

Declaration

[DataMember(Name = "partialViews")]
public IList<string> PartialViews { get; set; }

Property Value

Type	Description
IList<string>

View Source

Scripts

Gets or sets the collection of script paths included in this package.

Declaration

[DataMember(Name = "scripts")]
public IList<string> Scripts { get; set; }

Property Value

Type	Description
IList<string>

View Source

Stylesheets

Gets or sets the collection of stylesheet paths included in this package.

Declaration

[DataMember(Name = "stylesheets")]
public IList<string> Stylesheets { get; set; }

Property Value

Type	Description
IList<string>

View Source

Templates

Gets or sets the collection of template identifiers included in this package.

Declaration

[DataMember(Name = "templates")]
public IList<string> Templates { get; set; }

Property Value

Type	Description
IList<string>