Interface IPackageDataInstallation

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface IPackageDataInstallation

Methods

View Source

GetContentTypeKey(XElement)

Declaration

Guid GetContentTypeKey(XElement contentType)

Parameters

Type	Name	Description
XElement	contentType

Returns

Type	Description
Guid

View Source

GetEntityTypeAlias(XElement)

Declaration

string? GetEntityTypeAlias(XElement entityType)

Parameters

Type	Name	Description
XElement	entityType

Returns

Type	Description
string

View Source

ImportContentBase<TContentBase, TContentTypeComposition>(IEnumerable<CompiledPackageContentBase>, IDictionary<string, TContentTypeComposition>, int, IContentTypeBaseService<TContentTypeComposition>, IContentServiceBase<TContentBase>)

Declaration

IReadOnlyList<TContentBase> ImportContentBase<TContentBase, TContentTypeComposition>(IEnumerable<CompiledPackageContentBase> docs, IDictionary<string, TContentTypeComposition> importedDocumentTypes, int userId, IContentTypeBaseService<TContentTypeComposition> typeService, IContentServiceBase<TContentBase> service) where TContentBase : class, IContentBase where TContentTypeComposition : IContentTypeComposition

Parameters

Type	Name	Description
IEnumerable<CompiledPackageContentBase>	docs
IDictionary<string, TContentTypeComposition>	importedDocumentTypes
int	userId
IContentTypeBaseService<TContentTypeComposition>	typeService
IContentServiceBase<TContentBase>	service

Returns

Type	Description
IReadOnlyList<TContentBase>

Type Parameters

Name	Description
TContentBase
TContentTypeComposition

View Source

ImportDataTypes(IReadOnlyCollection<XElement>, int)

Imports and saves package xml as IDataType

Declaration

IReadOnlyList<IDataType> ImportDataTypes(IReadOnlyCollection<XElement> dataTypeElements, int userId)

Parameters

Type	Name	Description
IReadOnlyCollection<XElement>	dataTypeElements	Xml to import
int	userId	Optional id of the user

Returns

Type	Description
IReadOnlyList<IDataType>	An enumerable list of generated DataTypeDefinitions

View Source

ImportDictionaryItem(XElement, int, Guid?)

Declaration

IEnumerable<IDictionaryItem> ImportDictionaryItem(XElement dictionaryItemElement, int userId, Guid? parentId)

Parameters

Type	Name	Description
XElement	dictionaryItemElement
int	userId
Guid?	parentId

Returns

Type	Description
IEnumerable<IDictionaryItem>

View Source

ImportDictionaryItems(IEnumerable<XElement>, int)

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

Declaration

IReadOnlyList<IDictionaryItem> ImportDictionaryItems(IEnumerable<XElement> dictionaryItemElementList, int userId)

Parameters

Type	Name	Description
IEnumerable<XElement>	dictionaryItemElementList	Xml to import
int	userId

Returns

Type	Description
IReadOnlyList<IDictionaryItem>	An enumerable list of dictionary items

View Source

ImportDocumentType(XElement, int)

Declaration

IReadOnlyList<IContentType> ImportDocumentType(XElement docTypeElement, int userId)

Parameters

Type	Name	Description
XElement	docTypeElement
int	userId

Returns

Type	Description
IReadOnlyList<IContentType>

View Source

ImportDocumentTypes(IEnumerable<XElement>, int)

Imports and saves package xml as IContentType

Declaration

IReadOnlyList<IContentType> ImportDocumentTypes(IEnumerable<XElement> docTypeElements, int userId)

Parameters

Type	Name	Description
IEnumerable<XElement>	docTypeElements	Xml to import
int	userId	Optional id of the User performing the operation. Default is zero (admin).

Returns

Type	Description
IReadOnlyList<IContentType>	An enumerable list of generated ContentTypes

View Source

ImportLanguages(IEnumerable<XElement>, int)

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

Declaration

IReadOnlyList<ILanguage> ImportLanguages(IEnumerable<XElement> languageElements, int userId)

Parameters

Type	Name	Description
IEnumerable<XElement>	languageElements	Xml to import
int	userId	Optional id of the User performing the operation

Returns

Type	Description
IReadOnlyList<ILanguage>	An enumerable list of generated languages

View Source

ImportMediaTypes(IEnumerable<XElement>, int)

Imports and saves package xml as IMediaType.

Declaration

IReadOnlyList<IMediaType> ImportMediaTypes(IEnumerable<XElement> docTypeElements, int userId)

Parameters

Type	Name	Description
IEnumerable<XElement>	docTypeElements	Xml to import
int	userId	Optional id of the User performing the operation. Default is zero (admin).

Returns

Type	Description
IReadOnlyList<IMediaType>	An enumerable list of generated IMediaTypes.

View Source

ImportMemberTypes(IEnumerable<XElement>, int)

Imports and saves package xml as IMemberType.

Declaration

IReadOnlyList<IMemberType> ImportMemberTypes(IEnumerable<XElement> docTypeElements, int userId)

Parameters

Type	Name	Description
IEnumerable<XElement>	docTypeElements	Xml to import
int	userId	Optional id of the User performing the operation. Default is zero (admin).

Returns

Type	Description
IReadOnlyList<IMemberType>	An enumerable list of generated IMemberTypes.

View Source

ImportTemplateAsync(XElement, int)

Declaration

Task<IEnumerable<ITemplate>> ImportTemplateAsync(XElement templateElement, int userId)

Parameters

Type	Name	Description
XElement	templateElement
int	userId

Returns

Type	Description
Task<IEnumerable<ITemplate>>

View Source

ImportTemplatesAsync(IReadOnlyCollection<XElement>, int)

Imports and saves package xml as ITemplate

Declaration

Task<IReadOnlyList<ITemplate>> ImportTemplatesAsync(IReadOnlyCollection<XElement> templateElements, int userId)

Parameters

Type	Name	Description
IReadOnlyCollection<XElement>	templateElements	Xml to import
int	userId	Optional user id

Returns

Type	Description
Task<IReadOnlyList<ITemplate>>	An enumerable list of generated Templates

View Source

InstallPackageData(CompiledPackage, int)

Declaration

InstallationSummary InstallPackageData(CompiledPackage compiledPackage, int userId)

Parameters

Type	Name	Description
CompiledPackage	compiledPackage
int	userId

Returns

Type	Description
InstallationSummary