View Source

Interface IPackagingService

Namespace: Umbraco.Cms.Core.Services
Assembly: Umbraco.Core.dll
Syntax
public interface IPackagingService : IService

Methods

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

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()

Returns the created packages

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

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

GetInstalledPackageByName(String)

Declaration
InstalledPackage GetInstalledPackageByName(string packageName)
Parameters
Type Name Description
System.String packageName
Returns
Type Description
InstalledPackage
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