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:System.Dynamic.ExpandoObject

Assembly:Umbraco.Core.dll

Syntax

public class PackagingService : IPackagingService, IService

Constructors

PackagingService(ILogger, IContentService, IContentTypeService, IMediaService, IMacroService, IDataTypeService, IFileService, ILocalizationService, IEntityService, IUserService, RepositoryFactory, IScopeUnitOfWorkProvider)

Declaration

public PackagingService(ILogger logger, IContentService contentService, IContentTypeService contentTypeService, IMediaService mediaService, IMacroService macroService, IDataTypeService dataTypeService, IFileService fileService, ILocalizationService localizationService, IEntityService entityService, IUserService userService, RepositoryFactory repositoryFactory, IScopeUnitOfWorkProvider uowProvider)

Parameters

Type	Name	Description
ILogger	logger
IContentService	contentService
IContentTypeService	contentTypeService
IMediaService	mediaService
IMacroService	macroService
IDataTypeService	dataTypeService
IFileService	fileService
ILocalizationService	localizationService
IEntityService	entityService
IUserService	userService
RepositoryFactory	repositoryFactory
IScopeUnitOfWorkProvider	uowProvider

Methods

Export(IEnumerable<IDataTypeDefinition>, Boolean)

Exports a list of Data Types

Declaration

public XElement Export(IEnumerable<IDataTypeDefinition> dataTypeDefinitions, bool raiseEvents = true)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IDataTypeDefinition>	dataTypeDefinitions	List of data types to export
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Xml.Linq.XElement	System.Xml.Linq.XElement containing the xml representation of the IDataTypeDefinition objects

Export(IEnumerable<IDictionaryItem>, Boolean, Boolean)

Exports a list of IDictionaryItem items to xml as an System.Xml.Linq.XElement

Declaration

public XElement Export(IEnumerable<IDictionaryItem> dictionaryItem, bool includeChildren = true, bool raiseEvents = true)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IDictionaryItem>	dictionaryItem	List of dictionary items to export
System.Boolean	includeChildren	Optional boolean indicating whether or not to include children
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Xml.Linq.XElement	System.Xml.Linq.XElement containing the xml representation of the IDictionaryItem objects

Export(IEnumerable<ILanguage>, Boolean)

Exports a list of ILanguage items to xml as an System.Xml.Linq.XElement

Declaration

public XElement Export(IEnumerable<ILanguage> languages, bool raiseEvents = true)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<ILanguage>	languages	List of Languages to export
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Xml.Linq.XElement	System.Xml.Linq.XElement containing the xml representation of the ILanguage objects

Export(IEnumerable<IMacro>, Boolean)

Exports a list of IMacro items to xml as an System.Xml.Linq.XElement

Declaration

public XElement Export(IEnumerable<IMacro> macros, bool raiseEvents = true)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IMacro>	macros	Macros to export
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Xml.Linq.XElement	System.Xml.Linq.XElement containing the xml representation of the IMacro objects

Export(IEnumerable<ITemplate>, Boolean)

Exports a list of ITemplate items to xml as an System.Xml.Linq.XElement

Declaration

public XElement Export(IEnumerable<ITemplate> templates, bool raiseEvents = true)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<ITemplate>	templates	List of Templates to export
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Xml.Linq.XElement	System.Xml.Linq.XElement containing the xml representation of the ITemplate objects

Export(IContent, Boolean, Boolean)

Exports an IContent item to xml as an System.Xml.Linq.XElement

Declaration

public XElement Export(IContent content, bool deep = false, bool raiseEvents = true)

Parameters

Type	Name	Description
IContent	content	Content to export
System.Boolean	deep	Optional parameter indicating whether to include descendents
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Xml.Linq.XElement	System.Xml.Linq.XElement containing the xml representation of the Content object

Export(IContentType, Boolean)

Exports an IContentType to xml as an System.Xml.Linq.XElement

Declaration

public XElement Export(IContentType contentType, bool raiseEvents = true)

Parameters

Type	Name	Description
IContentType	contentType	ContentType to export
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Xml.Linq.XElement	System.Xml.Linq.XElement containing the xml representation of the ContentType item.

Export(IDataTypeDefinition, Boolean)

Exports a single Data Type

Declaration

public XElement Export(IDataTypeDefinition dataTypeDefinition, bool raiseEvents = true)

Parameters

Type	Name	Description
IDataTypeDefinition	dataTypeDefinition	Data type to export
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Xml.Linq.XElement	System.Xml.Linq.XElement containing the xml representation of the IDataTypeDefinition object

Export(IDictionaryItem, Boolean, Boolean)

Exports a single IDictionaryItem item to xml as an System.Xml.Linq.XElement

Declaration

public XElement Export(IDictionaryItem dictionaryItem, bool includeChildren, bool raiseEvents = true)

Parameters

Type	Name	Description
IDictionaryItem	dictionaryItem	Dictionary Item to export
System.Boolean	includeChildren	Optional boolean indicating whether or not to include children
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Xml.Linq.XElement	System.Xml.Linq.XElement containing the xml representation of the IDictionaryItem object

Export(ILanguage, Boolean)

Exports a single ILanguage item to xml as an System.Xml.Linq.XElement

Declaration

public XElement Export(ILanguage language, bool raiseEvents = true)

Parameters

Type	Name	Description
ILanguage	language	Language to export
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Xml.Linq.XElement	System.Xml.Linq.XElement containing the xml representation of the ILanguage object

Export(IMacro, Boolean)

Exports a single IMacro item to xml as an System.Xml.Linq.XElement

Declaration

public XElement Export(IMacro macro, bool raiseEvents = true)

Parameters

Type	Name	Description
IMacro	macro	Macro to export
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Xml.Linq.XElement	System.Xml.Linq.XElement containing the xml representation of the IMacro object

Export(IMedia, Boolean, Boolean)

Exports an IMedia item to xml as an System.Xml.Linq.XElement

Declaration

public XElement Export(IMedia media, bool deep = false, bool raiseEvents = true)

Parameters

Type	Name	Description
IMedia	media	Media to export
System.Boolean	deep	Optional parameter indicating whether to include descendents
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Xml.Linq.XElement	System.Xml.Linq.XElement containing the xml representation of the Media object

Export(IMember)

Exports an IMedia item to xml as an System.Xml.Linq.XElement

Declaration

public XElement Export(IMember member)

Parameters

Type	Name	Description
IMember	member	Member to export

Returns

Type	Description
System.Xml.Linq.XElement	System.Xml.Linq.XElement containing the xml representation of the Member object

Export(ITemplate, Boolean)

Exports a single ITemplate item to xml as an System.Xml.Linq.XElement

Declaration

public XElement Export(ITemplate template, bool raiseEvents = true)

Parameters

Type	Name	Description
ITemplate	template	Template to export
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Xml.Linq.XElement	System.Xml.Linq.XElement containing the xml representation of the ITemplate object

FetchPackageFile(Guid, Version, Int32)

This will fetch an Umbraco package file from the package repository and return the relative file path to the downloaded package file

Declaration

public string FetchPackageFile(Guid packageId, Version umbracoVersion, int userId)

Parameters

Type	Name	Description
System.Guid	packageId
System.Version	umbracoVersion
System.Int32	userId	The current user id performing the operation

Returns

Type	Description
System.String

ImportContent(XElement, Int32, Int32, Boolean)

Imports and saves package xml as IContent

Declaration

public IEnumerable<IContent> ImportContent(XElement element, int parentId = -1, int userId = 0, bool raiseEvents = true)

Parameters

Type	Name	Description
System.Xml.Linq.XElement	element	Xml to import
System.Int32	parentId	Optional parent Id for the content being imported
System.Int32	userId	Optional Id of the user performing the import
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Collections.Generic.IEnumerable<IContent>	An enumrable list of generated content

ImportContentTypes(XElement, Boolean, Int32, Boolean)

Imports and saves package xml as IContentType

Declaration

public IEnumerable<IContentType> ImportContentTypes(XElement element, bool importStructure, int userId = 0, bool raiseEvents = true)

Parameters

Type	Name	Description
System.Xml.Linq.XElement	element	Xml to import
System.Boolean	importStructure	Boolean indicating whether or not to import the
System.Int32	userId	Optional id of the User performing the operation. Default is zero (admin).
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Collections.Generic.IEnumerable<IContentType>	An enumrable list of generated ContentTypes

ImportContentTypes(XElement, Int32, Boolean)

Imports and saves package xml as IContentType

Declaration

public IEnumerable<IContentType> ImportContentTypes(XElement element, int userId = 0, bool raiseEvents = true)

Parameters

Type	Name	Description
System.Xml.Linq.XElement	element	Xml to import
System.Int32	userId	Optional id of the User performing the operation. Default is zero (admin).
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Collections.Generic.IEnumerable<IContentType>	An enumrable list of generated ContentTypes

ImportDataTypeDefinitions(XElement, Int32, Boolean)

Imports and saves package xml as IDataTypeDefinition

Declaration

public IEnumerable<IDataTypeDefinition> ImportDataTypeDefinitions(XElement element, int userId = 0, bool raiseEvents = true)

Parameters

Type	Name	Description
System.Xml.Linq.XElement	element	Xml to import
System.Int32	userId	Optional id of the user
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Collections.Generic.IEnumerable<IDataTypeDefinition>	An enumrable list of generated DataTypeDefinitions

ImportDictionaryItems(XElement, Boolean)

Imports and saves the 'DictionaryItems' part of the package xml as a list of IDictionaryItem

Declaration

public IEnumerable<IDictionaryItem> ImportDictionaryItems(XElement dictionaryItemElementList, bool raiseEvents = true)

Parameters

Type	Name	Description
System.Xml.Linq.XElement	dictionaryItemElementList	Xml to import
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Collections.Generic.IEnumerable<IDictionaryItem>	An enumerable list of dictionary items

ImportLanguages(XElement, Int32, Boolean)

Imports and saves the 'Languages' part of a package xml as a list of ILanguage

Declaration

public IEnumerable<ILanguage> ImportLanguages(XElement languageElementList, int userId = 0, bool raiseEvents = true)

Parameters

Type	Name	Description
System.Xml.Linq.XElement	languageElementList	Xml to import
System.Int32	userId	Optional id of the User performing the operation
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Collections.Generic.IEnumerable<ILanguage>	An enumerable list of generated languages

ImportMacros(XElement, Int32, Boolean)

Imports and saves the 'Macros' part of a package xml as a list of IMacro

Declaration

public IEnumerable<IMacro> ImportMacros(XElement element, int userId = 0, bool raiseEvents = true)

Parameters

Type	Name	Description
System.Xml.Linq.XElement	element	Xml to import
System.Int32	userId	Optional id of the User performing the operation
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Collections.Generic.IEnumerable<IMacro>

ImportStylesheets(XElement, Int32, Boolean)

Declaration

public IEnumerable<IFile> ImportStylesheets(XElement element, int userId = 0, bool raiseEvents = true)

Parameters

Type	Name	Description
System.Xml.Linq.XElement	element
System.Int32	userId
System.Boolean	raiseEvents

Returns

Type	Description
System.Collections.Generic.IEnumerable<IFile>

ImportTemplates(XElement, Int32, Boolean)

Imports and saves package xml as ITemplate

Declaration

public IEnumerable<ITemplate> ImportTemplates(XElement element, int userId = 0, bool raiseEvents = true)

Parameters

Type	Name	Description
System.Xml.Linq.XElement	element	Xml to import
System.Int32	userId	Optional user id
System.Boolean	raiseEvents	Optional parameter indicating whether or not to raise events

Returns

Type	Description
System.Collections.Generic.IEnumerable<ITemplate>	An enumrable list of generated Templates

Events

ExportedContent

Occurs after Content is Exported to Xml

Declaration

public static event TypedEventHandler<IPackagingService, ExportEventArgs<IContent>> ExportedContent

Event Type

Type	Description
TypedEventHandler<IPackagingService, ExportEventArgs<IContent>>

ExportedContentType

Occurs after ContentType is Exported to Xml

Declaration

public static event TypedEventHandler<IPackagingService, ExportEventArgs<IContentType>> ExportedContentType

Event Type

Type	Description
TypedEventHandler<IPackagingService, ExportEventArgs<IContentType>>

ExportedDataType

Occurs after DataType is Exported to Xml

Declaration

public static event TypedEventHandler<IPackagingService, ExportEventArgs<IDataTypeDefinition>> ExportedDataType

Event Type

Type	Description
TypedEventHandler<IPackagingService, ExportEventArgs<IDataTypeDefinition>>

ExportedDictionaryItem

Occurs after DictionaryItem is Exported to Xml

Declaration

public static event TypedEventHandler<IPackagingService, ExportEventArgs<IDictionaryItem>> ExportedDictionaryItem

Event Type

Type	Description
TypedEventHandler<IPackagingService, ExportEventArgs<IDictionaryItem>>

ExportedLanguage

Occurs after Language is Exported to Xml

Declaration

public static event TypedEventHandler<IPackagingService, ExportEventArgs<ILanguage>> ExportedLanguage

Event Type

Type	Description
TypedEventHandler<IPackagingService, ExportEventArgs<ILanguage>>

ExportedMacro

Occurs after Macro is Exported to Xml

Declaration

public static event TypedEventHandler<IPackagingService, ExportEventArgs<IMacro>> ExportedMacro

Event Type

Type	Description
TypedEventHandler<IPackagingService, ExportEventArgs<IMacro>>

ExportedMedia

Occurs after Media is Exported to Xml

Declaration

public static event TypedEventHandler<IPackagingService, ExportEventArgs<IMedia>> ExportedMedia

Event Type

Type	Description
TypedEventHandler<IPackagingService, ExportEventArgs<IMedia>>

ExportedTemplate

Occurs after Template is Exported to Xml

Declaration

public static event TypedEventHandler<IPackagingService, ExportEventArgs<ITemplate>> ExportedTemplate

Event Type

Type	Description
TypedEventHandler<IPackagingService, ExportEventArgs<ITemplate>>

ExportingContent

Declaration

public static event TypedEventHandler<IPackagingService, ExportEventArgs<IContent>> ExportingContent

Event Type

Type	Description
TypedEventHandler<IPackagingService, ExportEventArgs<IContent>>

ExportingContentType

Occurs before Exporting ContentType

Declaration

public static event TypedEventHandler<IPackagingService, ExportEventArgs<IContentType>> ExportingContentType

Event Type

Type	Description
TypedEventHandler<IPackagingService, ExportEventArgs<IContentType>>

ExportingDataType

Occurs before Exporting DataType

Declaration

public static event TypedEventHandler<IPackagingService, ExportEventArgs<IDataTypeDefinition>> ExportingDataType

Event Type

Type	Description
TypedEventHandler<IPackagingService, ExportEventArgs<IDataTypeDefinition>>

ExportingDictionaryItem

Occurs before Exporting DictionaryItem

Declaration

public static event TypedEventHandler<IPackagingService, ExportEventArgs<IDictionaryItem>> ExportingDictionaryItem

Event Type

Type	Description
TypedEventHandler<IPackagingService, ExportEventArgs<IDictionaryItem>>

ExportingLanguage

Occurs before Exporting Language

Declaration

public static event TypedEventHandler<IPackagingService, ExportEventArgs<ILanguage>> ExportingLanguage

Event Type

Type	Description
TypedEventHandler<IPackagingService, ExportEventArgs<ILanguage>>

ExportingMacro

Occurs before Exporting Macro

Declaration

public static event TypedEventHandler<IPackagingService, ExportEventArgs<IMacro>> ExportingMacro

Event Type

Type	Description
TypedEventHandler<IPackagingService, ExportEventArgs<IMacro>>

ExportingMedia

Occurs before Exporting Media

Declaration

public static event TypedEventHandler<IPackagingService, ExportEventArgs<IMedia>> ExportingMedia

Event Type

Type	Description
TypedEventHandler<IPackagingService, ExportEventArgs<IMedia>>

ExportingTemplate

Occurs before Exporting Template

Declaration

public static event TypedEventHandler<IPackagingService, ExportEventArgs<ITemplate>> ExportingTemplate

Event Type

Type	Description
TypedEventHandler<IPackagingService, ExportEventArgs<ITemplate>>

ImportedContent

Occurs after Content is Imported and Saved

Declaration

public static event TypedEventHandler<IPackagingService, ImportEventArgs<IContent>> ImportedContent

Event Type

Type	Description
TypedEventHandler<IPackagingService, ImportEventArgs<IContent>>

ImportedContentType

Occurs after ContentType is Imported and Saved

Declaration

public static event TypedEventHandler<IPackagingService, ImportEventArgs<IContentType>> ImportedContentType

Event Type

Type	Description
TypedEventHandler<IPackagingService, ImportEventArgs<IContentType>>

ImportedDataType

Occurs after DataType is Imported and Saved

Declaration

public static event TypedEventHandler<IPackagingService, ImportEventArgs<IDataTypeDefinition>> ImportedDataType

Event Type

Type	Description
TypedEventHandler<IPackagingService, ImportEventArgs<IDataTypeDefinition>>

ImportedDictionaryItem

Occurs after DictionaryItem is Imported and Saved

Declaration

public static event TypedEventHandler<IPackagingService, ImportEventArgs<IDictionaryItem>> ImportedDictionaryItem

Event Type

Type	Description
TypedEventHandler<IPackagingService, ImportEventArgs<IDictionaryItem>>

ImportedLanguage

Occurs after Language is Imported and Saved

Declaration

public static event TypedEventHandler<IPackagingService, ImportEventArgs<ILanguage>> ImportedLanguage

Event Type

Type	Description
TypedEventHandler<IPackagingService, ImportEventArgs<ILanguage>>

ImportedMacro

Occurs after Macro is Imported and Saved

Declaration

public static event TypedEventHandler<IPackagingService, ImportEventArgs<IMacro>> ImportedMacro

Event Type

Type	Description
TypedEventHandler<IPackagingService, ImportEventArgs<IMacro>>

ImportedPackage

Occurs after a package is imported

Declaration

public static event TypedEventHandler<IPackagingService, ImportPackageEventArgs<InstallationSummary>> ImportedPackage

Event Type

Type	Description
TypedEventHandler<IPackagingService, ImportPackageEventArgs<InstallationSummary>>

ImportedTemplate

Occurs after Template is Imported and Saved

Declaration

public static event TypedEventHandler<IPackagingService, ImportEventArgs<ITemplate>> ImportedTemplate

Event Type

Type	Description
TypedEventHandler<IPackagingService, ImportEventArgs<ITemplate>>

ImportingContent

Occurs before Importing Content

Declaration

public static event TypedEventHandler<IPackagingService, ImportEventArgs<IContent>> ImportingContent

Event Type

Type	Description
TypedEventHandler<IPackagingService, ImportEventArgs<IContent>>

ImportingContentType

Occurs before Importing ContentType

Declaration

public static event TypedEventHandler<IPackagingService, ImportEventArgs<IContentType>> ImportingContentType

Event Type

Type	Description
TypedEventHandler<IPackagingService, ImportEventArgs<IContentType>>

ImportingDataType

Occurs before Importing DataType

Declaration

public static event TypedEventHandler<IPackagingService, ImportEventArgs<IDataTypeDefinition>> ImportingDataType

Event Type

Type	Description
TypedEventHandler<IPackagingService, ImportEventArgs<IDataTypeDefinition>>

ImportingDictionaryItem

Occurs before Importing DictionaryItem

Declaration

public static event TypedEventHandler<IPackagingService, ImportEventArgs<IDictionaryItem>> ImportingDictionaryItem

Event Type

Type	Description
TypedEventHandler<IPackagingService, ImportEventArgs<IDictionaryItem>>

ImportingLanguage

Occurs before Importing Language

Declaration

public static event TypedEventHandler<IPackagingService, ImportEventArgs<ILanguage>> ImportingLanguage

Event Type

Type	Description
TypedEventHandler<IPackagingService, ImportEventArgs<ILanguage>>

ImportingMacro

Occurs before Importing Macro

Declaration

public static event TypedEventHandler<IPackagingService, ImportEventArgs<IMacro>> ImportingMacro

Event Type

Type	Description
TypedEventHandler<IPackagingService, ImportEventArgs<IMacro>>

ImportingStylesheets

Occurs before Importing Stylesheets

Declaration

public static event TypedEventHandler<IPackagingService, ImportEventArgs<IFile>> ImportingStylesheets

Event Type

Type	Description
TypedEventHandler<IPackagingService, ImportEventArgs<IFile>>

ImportingTemplate

Occurs before Importing Template

Declaration

public static event TypedEventHandler<IPackagingService, ImportEventArgs<ITemplate>> ImportingTemplate

Event Type

Type	Description
TypedEventHandler<IPackagingService, ImportEventArgs<ITemplate>>

UninstalledPackage

Occurs after a package is uninstalled

Declaration

public static event TypedEventHandler<IPackagingService, UninstallPackageEventArgs<UninstallationSummary>> UninstalledPackage

Event Type

Type	Description
TypedEventHandler<IPackagingService, UninstallPackageEventArgs<UninstallationSummary>>