View Source

Class PackagingService

Represents the Packaging Service, which provides import/export functionality for the Core models of the API using xml representation. This is primarily used by the Package functionality.

Inheritance
System.Object
Namespace: Umbraco.Cms.Core.Services.Implement
Assembly: Umbraco.Infrastructure.dll
Syntax
public class PackagingService : IPackagingService, IService

Constructors

View Source

PackagingService(IAuditService, ICreatedPackagesRepository, IPackageInstallation, IEventAggregator, IKeyValueService, ICoreScopeProvider, PackageMigrationPlanCollection, IHostEnvironment, IUserService)

Declaration
public PackagingService(IAuditService auditService, ICreatedPackagesRepository createdPackages, IPackageInstallation packageInstallation, IEventAggregator eventAggregator, IKeyValueService keyValueService, ICoreScopeProvider coreScopeProvider, PackageMigrationPlanCollection packageMigrationPlans, IHostEnvironment hostEnvironment, IUserService userService)
Parameters
Type Name Description
IAuditService auditService
ICreatedPackagesRepository createdPackages
IPackageInstallation packageInstallation
IEventAggregator eventAggregator
IKeyValueService keyValueService
ICoreScopeProvider coreScopeProvider
PackageMigrationPlanCollection packageMigrationPlans
IHostEnvironment hostEnvironment
IUserService userService
View Source

PackagingService(IAuditService, ICreatedPackagesRepository, IPackageInstallation, IEventAggregator, IKeyValueService, ICoreScopeProvider, PackageMigrationPlanCollection, IPackageManifestReader, IHostEnvironment, IUserService)

Declaration
public PackagingService(IAuditService auditService, ICreatedPackagesRepository createdPackages, IPackageInstallation packageInstallation, IEventAggregator eventAggregator, IKeyValueService keyValueService, ICoreScopeProvider coreScopeProvider, PackageMigrationPlanCollection packageMigrationPlans, IPackageManifestReader packageManifestReader, IHostEnvironment hostEnvironment, IUserService userService)
Parameters
Type Name Description
IAuditService auditService
ICreatedPackagesRepository createdPackages
IPackageInstallation packageInstallation
IEventAggregator eventAggregator
IKeyValueService keyValueService
ICoreScopeProvider coreScopeProvider
PackageMigrationPlanCollection packageMigrationPlans
IPackageManifestReader packageManifestReader
IHostEnvironment hostEnvironment
IUserService userService

Methods

View Source

CreateCreatedPackageAsync(PackageDefinition, Guid)

Declaration
public async Task<Attempt<PackageDefinition, PackageOperationStatus>> CreateCreatedPackageAsync(PackageDefinition package, Guid userKey)
Parameters
Type Name Description
PackageDefinition package
Guid userKey
Returns
Type Description
Task<Attempt<PackageDefinition, PackageOperationStatus>>
View Source

DeleteCreatedPackage(Int32, Int32)

Declaration
public void DeleteCreatedPackage(int id, int userId = -1)
Parameters
Type Name Description
System.Int32 id
System.Int32 userId
View Source

DeleteCreatedPackageAsync(Guid, Guid)

Declaration
public async Task<Attempt<PackageDefinition, PackageOperationStatus>> DeleteCreatedPackageAsync(Guid key, Guid userKey)
Parameters
Type Name Description
Guid key
Guid userKey
Returns
Type Description
Task<Attempt<PackageDefinition, PackageOperationStatus>>
View Source

ExportCreatedPackage(PackageDefinition)

Declaration
public string ExportCreatedPackage(PackageDefinition definition)
Parameters
Type Name Description
PackageDefinition definition
Returns
Type Description
System.String
View Source

GetAllCreatedPackages()

Declaration
public IEnumerable<PackageDefinition> GetAllCreatedPackages()
Returns
Type Description
IEnumerable<PackageDefinition>
View Source

GetAllInstalledPackages()

Declaration
public IEnumerable<InstalledPackage> GetAllInstalledPackages()
Returns
Type Description
IEnumerable<InstalledPackage>
View Source

GetAllInstalledPackagesAsync()

Declaration
public async Task<IEnumerable<InstalledPackage>> GetAllInstalledPackagesAsync()
Returns
Type Description
Task<IEnumerable<InstalledPackage>>
View Source

GetCompiledPackageInfo(XDocument)

Declaration
public CompiledPackage GetCompiledPackageInfo(XDocument xml)
Parameters
Type Name Description
System.Xml.Linq.XDocument xml
Returns
Type Description
CompiledPackage
View Source

GetCreatedPackageById(Int32)

Declaration
public PackageDefinition GetCreatedPackageById(int id)
Parameters
Type Name Description
System.Int32 id
Returns
Type Description
PackageDefinition
View Source

GetCreatedPackageByKeyAsync(Guid)

Declaration
public Task<PackageDefinition> GetCreatedPackageByKeyAsync(Guid key)
Parameters
Type Name Description
Guid key
Returns
Type Description
Task<PackageDefinition>
View Source

GetCreatedPackagesAsync(Int32, Int32)

Declaration
public async Task<PagedModel<PackageDefinition>> GetCreatedPackagesAsync(int skip, int take)
Parameters
Type Name Description
System.Int32 skip
System.Int32 take
Returns
Type Description
Task<PagedModel<PackageDefinition>>
View Source

GetInstalledPackageByName(String)

Declaration
public InstalledPackage GetInstalledPackageByName(string packageName)
Parameters
Type Name Description
System.String packageName
Returns
Type Description
InstalledPackage
View Source

GetInstalledPackagesFromMigrationPlansAsync(Int32, Int32)

Declaration
public 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)

Declaration
public Stream? GetPackageFileStream(PackageDefinition definition)
Parameters
Type Name Description
PackageDefinition definition
Returns
Type Description
System.Nullable<Stream>
View Source

InstallCompiledPackageData(FileInfo, Int32)

Declaration
public 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
public 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)

Declaration
public bool SaveCreatedPackage(PackageDefinition definition)
Parameters
Type Name Description
PackageDefinition definition
Returns
Type Description
System.Boolean
View Source

UpdateCreatedPackageAsync(PackageDefinition, Guid)

Declaration
public async Task<Attempt<PackageDefinition, PackageOperationStatus>> UpdateCreatedPackageAsync(PackageDefinition package, Guid userKey)
Parameters
Type Name Description
PackageDefinition package
Guid userKey
Returns
Type Description
Task<Attempt<PackageDefinition, PackageOperationStatus>>