Interface IPackagingService

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface IPackagingService : IService

Methods

View Source

CreateCreatedPackageAsync(PackageDefinition, Guid)

Creates a new package.

Declaration

Task<Attempt<PackageDefinition, PackageOperationStatus>> CreateCreatedPackageAsync(PackageDefinition package, Guid userKey)

Parameters

Type	Name	Description
PackageDefinition	package	PackageDefinitionmodel for the package to create.
Guid	userKey	Key of the user performing the create.

Returns

Type	Description
Task<Attempt<PackageDefinition, PackageOperationStatus>>

View Source

DeleteCreatedPackage(Int32, Int32)

Declaration

void DeleteCreatedPackage(int id, int userId = -1)

Parameters

Type	Name	Description
System.Int32	id
System.Int32	userId

View Source

DeleteCreatedPackageAsync(Guid, Guid)

Deletes a created package by key.

Declaration

Task<Attempt<PackageDefinition, PackageOperationStatus>> DeleteCreatedPackageAsync(Guid key, Guid userKey)

Parameters

Type	Name	Description
Guid	key	The key of the package.
Guid	userKey	Key of the user deleting the package.

Returns

Type	Description
Task<Attempt<PackageDefinition, PackageOperationStatus>>

View Source

ExportCreatedPackage(PackageDefinition)

Creates the package file and returns it's physical path

Declaration

string ExportCreatedPackage(PackageDefinition definition)

Parameters

Type	Name	Description
PackageDefinition	definition

Returns

Type	Description
System.String

View Source

GetAllCreatedPackages()

Declaration

IEnumerable<PackageDefinition> GetAllCreatedPackages()

Returns

Type	Description
IEnumerable<PackageDefinition>

View Source

GetAllInstalledPackages()

Returns the advertised installed packages

Declaration

IEnumerable<InstalledPackage> GetAllInstalledPackages()

Returns

Type	Description
IEnumerable<InstalledPackage>

View Source

GetAllInstalledPackagesAsync()

Returns the advertised installed packages

Declaration

virtual Task<IEnumerable<InstalledPackage>> GetAllInstalledPackagesAsync()

Returns

Type	Description
Task<IEnumerable<InstalledPackage>>

View Source

GetCompiledPackageInfo(XDocument)

Returns a CompiledPackage result from an umbraco package file (zip)

Declaration

CompiledPackage GetCompiledPackageInfo(XDocument packageXml)

Parameters

Type	Name	Description
System.Xml.Linq.XDocument	packageXml

Returns

Type	Description
CompiledPackage

View Source

GetCreatedPackageById(Int32)

Returns a created package by id

Declaration

PackageDefinition GetCreatedPackageById(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
PackageDefinition

View Source

GetCreatedPackageByKeyAsync(Guid)

Returns a created package by key.

Declaration

Task<PackageDefinition> GetCreatedPackageByKeyAsync(Guid key)

Parameters

Type	Name	Description
Guid	key	The key of the package.

Returns

Type	Description
Task<PackageDefinition>	The package or null if the package was not found.

View Source

GetCreatedPackagesAsync(Int32, Int32)

Returns the created packages as a paged model.

Declaration

virtual Task<PagedModel<PackageDefinition>> GetCreatedPackagesAsync(int skip, int take)

Parameters

Type	Name	Description
System.Int32	skip	The amount of items to skip.
System.Int32	take	The amount of items to take.

Returns

Type	Description
Task<PagedModel<PackageDefinition>>

View Source

GetInstalledPackageByName(String)

Declaration

InstalledPackage GetInstalledPackageByName(string packageName)

Parameters

Type	Name	Description
System.String	packageName

Returns

Type	Description
InstalledPackage

View Source

GetInstalledPackagesFromMigrationPlansAsync(Int32, Int32)

Returns installed packages collected from the package migration plans.

Declaration

Task<PagedModel<InstalledPackage>> GetInstalledPackagesFromMigrationPlansAsync(int skip, int take)

Parameters

Type	Name	Description
System.Int32	skip
System.Int32	take

Returns

Type	Description
Task<PagedModel<InstalledPackage>>

View Source

GetPackageFileStream(PackageDefinition)

Gets the package file stream.

Declaration

virtual Stream? GetPackageFileStream(PackageDefinition definition)

Parameters

Type	Name	Description
PackageDefinition	definition

Returns

Type	Description
System.Nullable<Stream>

View Source

InstallCompiledPackageData(FileInfo, Int32)

Installs the data, entities, objects contained in an umbraco package file (zip)

Declaration

InstallationSummary InstallCompiledPackageData(FileInfo packageXmlFile, int userId = -1)

Parameters

Type	Name	Description
FileInfo	packageXmlFile
System.Int32	userId

Returns

Type	Description
InstallationSummary

View Source

InstallCompiledPackageData(XDocument, Int32)

Declaration

InstallationSummary InstallCompiledPackageData(XDocument packageXml, int userId = -1)

Parameters

Type	Name	Description
System.Xml.Linq.XDocument	packageXml
System.Int32	userId

Returns

Type	Description
InstallationSummary

View Source

SaveCreatedPackage(PackageDefinition)

Persists a package definition to storage

Declaration

bool SaveCreatedPackage(PackageDefinition definition)

Parameters

Type	Name	Description
PackageDefinition	definition

Returns

Type	Description
System.Boolean

View Source

UpdateCreatedPackageAsync(PackageDefinition, Guid)

Updates a created package.

Declaration

Task<Attempt<PackageDefinition, PackageOperationStatus>> UpdateCreatedPackageAsync(PackageDefinition package, Guid userKey)

Parameters

Type	Name	Description
PackageDefinition	package	PackageDefinitionmodel for the package to update.
Guid	userKey	Key of the user performing the update.

Returns

Type	Description
Task<Attempt<PackageDefinition, PackageOperationStatus>>