Interface IContentTypeBaseService<TItem>

Provides a common base interface for IContentTypeService, IMediaTypeService and IMemberTypeService.

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface IContentTypeBaseService<TItem> : IContentTypeBaseService, IService where TItem : IContentTypeComposition

Type Parameters

Name	Description
TItem	The type of the item.

Methods

View Source

Copy(TItem, int)

Declaration

[Obsolete("Please use CopyAsync. Will be removed in V16.")]
Attempt<OperationResult<MoveOperationStatusType, TItem>?> Copy(TItem copying, int containerId)

Parameters

Type	Name	Description
TItem	copying
int	containerId

Returns

Type	Description
Attempt<OperationResult<MoveOperationStatusType, TItem>>

View Source

Copy(TItem, string, string, int)

Declaration

[Obsolete("Please use CopyAsync. Will be removed in V15.")]
TItem Copy(TItem original, string alias, string name, int parentId = -1)

Parameters

Type	Name	Description
TItem	original
string	alias
string	name
int	parentId

Returns

Type	Description
TItem

View Source

Copy(TItem, string, string, TItem)

Declaration

[Obsolete("Please use CopyAsync. Will be removed in V15.")]
TItem Copy(TItem original, string alias, string name, TItem parent)

Parameters

Type	Name	Description
TItem	original
string	alias
string	name
TItem	parent

Returns

Type	Description
TItem

View Source

CopyAsync(Guid, Guid?)

Declaration

Task<Attempt<TItem?, ContentTypeStructureOperationStatus>> CopyAsync(Guid key, Guid? containerKey)

Parameters

Type	Name	Description
Guid	key
Guid?	containerKey

Returns

Type	Description
Task<Attempt<TItem, ContentTypeStructureOperationStatus>>

View Source

Count()

Declaration

int Count()

Returns

Type	Description
int

View Source

CreateAsync(TItem, Guid)

Declaration

Task<Attempt<ContentTypeOperationStatus>> CreateAsync(TItem item, Guid performingUserKey)

Parameters

Type	Name	Description
TItem	item
Guid	performingUserKey

Returns

Type	Description
Task<Attempt<ContentTypeOperationStatus>>

View Source

CreateContainer(int, Guid, string, int)

Declaration

Attempt<OperationResult<OperationResultType, EntityContainer>?> CreateContainer(int parentContainerId, Guid key, string name, int userId = -1)

Parameters

Type	Name	Description
int	parentContainerId
Guid	key
string	name
int	userId

Returns

Type	Description
Attempt<OperationResult<OperationResultType, EntityContainer>>

View Source

Delete(IEnumerable<TItem>, int)

Declaration

void Delete(IEnumerable<TItem> item, int userId = -1)

Parameters

Type	Name	Description
IEnumerable<TItem>	item
int	userId

View Source

Delete(TItem, int)

Declaration

void Delete(TItem item, int userId = -1)

Parameters

Type	Name	Description
TItem	item
int	userId

View Source

DeleteAsync(Guid, Guid)

Deletes an item

Declaration

Task<ContentTypeOperationStatus> DeleteAsync(Guid key, Guid performingUserKey)

Parameters

Type	Name	Description
Guid	key	The item to delete.
Guid	performingUserKey

Returns

Type	Description
Task<ContentTypeOperationStatus>

View Source

DeleteContainer(int, int)

Declaration

Attempt<OperationResult?> DeleteContainer(int containerId, int userId = -1)

Parameters

Type	Name	Description
int	containerId
int	userId

Returns

Type	Description
Attempt<OperationResult>

View Source

Get(Guid)

Gets a content type.

Declaration

TItem? Get(Guid key)

Parameters

Type	Name	Description
Guid	key

Returns

Type	Description
TItem

View Source

Get(int)

Gets a content type.

Declaration

TItem? Get(int id)

Parameters

Type	Name	Description
int	id

Returns

Type	Description
TItem

View Source

Get(string)

Gets a content type.

Declaration

TItem? Get(string alias)

Parameters

Type	Name	Description
string	alias

Returns

Type	Description
TItem

View Source

GetAll()

Declaration

IEnumerable<TItem> GetAll()

Returns

Type	Description
IEnumerable<TItem>

View Source

GetAllAllowedAsRootAsync(int, int)

Returns all the content type allowed as root.

Declaration

Task<PagedModel<TItem>> GetAllAllowedAsRootAsync(int skip, int take)

Parameters

Type	Name	Description
int	skip
int	take

Returns

Type	Description
Task<PagedModel<TItem>>

View Source

GetAllowedChildrenAsync(Guid, int, int)

Returns all content types allowed as children for a given content type key.

Declaration

Task<Attempt<PagedModel<TItem>?, ContentTypeOperationStatus>> GetAllowedChildrenAsync(Guid key, int skip, int take)

Parameters

Type	Name	Description
Guid	key	The content type key.
int	skip
int	take

Returns

Type	Description
Task<Attempt<PagedModel<TItem>, ContentTypeOperationStatus>>

View Source

GetAllowedChildrenAsync(Guid, Guid?, int, int)

Returns all content types allowed as children for a given content type key.

Declaration

Task<Attempt<PagedModel<TItem>?, ContentTypeOperationStatus>> GetAllowedChildrenAsync(Guid key, Guid? parentContentKey, int skip, int take)

Parameters

Type	Name	Description
Guid	key	The content type key.
Guid?	parentContentKey	The parent content key.
int	skip
int	take

Returns

Type	Description
Task<Attempt<PagedModel<TItem>, ContentTypeOperationStatus>>

View Source

GetAsync(Guid)

Gets a content type.

Declaration

Task<TItem?> GetAsync(Guid guid)

Parameters

Type	Name	Description
Guid	guid	The key of the content type.

Returns

Type	Description
Task<TItem>	The found content type, null if none was found.

View Source

GetChildren(Guid)

Declaration

IEnumerable<TItem> GetChildren(Guid id)

Parameters

Type	Name	Description
Guid	id

Returns

Type	Description
IEnumerable<TItem>

View Source

GetChildren(int)

Declaration

IEnumerable<TItem> GetChildren(int id)

Parameters

Type	Name	Description
int	id

Returns

Type	Description
IEnumerable<TItem>

View Source

GetComposedOf(int)

Declaration

IEnumerable<TItem> GetComposedOf(int id)

Parameters

Type	Name	Description
int	id

Returns

Type	Description
IEnumerable<TItem>

View Source

GetContainer(Guid)

Declaration

EntityContainer? GetContainer(Guid containerId)

Parameters

Type	Name	Description
Guid	containerId

Returns

Type	Description
EntityContainer

View Source

GetContainer(int)

Declaration

EntityContainer? GetContainer(int containerId)

Parameters

Type	Name	Description
int	containerId

Returns

Type	Description
EntityContainer

View Source

GetContainers(int[])

Declaration

IEnumerable<EntityContainer> GetContainers(int[] containerIds)

Parameters

Type	Name	Description
int[]	containerIds

Returns

Type	Description
IEnumerable<EntityContainer>

View Source

GetContainers(string, int)

Declaration

IEnumerable<EntityContainer> GetContainers(string folderName, int level)

Parameters

Type	Name	Description
string	folderName
int	level

Returns

Type	Description
IEnumerable<EntityContainer>

View Source

GetContainers(TItem)

Declaration

IEnumerable<EntityContainer> GetContainers(TItem contentType)

Parameters

Type	Name	Description
TItem	contentType

Returns

Type	Description
IEnumerable<EntityContainer>

View Source

GetDescendants(int, bool)

Declaration

IEnumerable<TItem> GetDescendants(int id, bool andSelf)

Parameters

Type	Name	Description
int	id
bool	andSelf

Returns

Type	Description
IEnumerable<TItem>

View Source

GetMany(IEnumerable<Guid>?)

Declaration

IEnumerable<TItem> GetMany(IEnumerable<Guid>? ids)

Parameters

Type	Name	Description
IEnumerable<Guid>	ids

Returns

Type	Description
IEnumerable<TItem>

View Source

GetMany(params int[])

Declaration

IEnumerable<TItem> GetMany(params int[] ids)

Parameters

Type	Name	Description
int[]	ids

Returns

Type	Description
IEnumerable<TItem>

View Source

HasChildren(Guid)

Declaration

bool HasChildren(Guid id)

Parameters

Type	Name	Description
Guid	id

Returns

Type	Description
bool

View Source

HasChildren(int)

Declaration

bool HasChildren(int id)

Parameters

Type	Name	Description
int	id

Returns

Type	Description
bool

View Source

HasContainerInPath(params int[])

Gets a value indicating whether there is a list view content item in the path.

Declaration

bool HasContainerInPath(params int[] ids)

Parameters

Type	Name	Description
int[]	ids

Returns

Type	Description
bool

View Source

HasContainerInPath(string)

Given the path of a content item, this will return true if the content item exists underneath a list view content item

Declaration

bool HasContainerInPath(string contentPath)

Parameters

Type	Name	Description
string	contentPath

Returns

Type	Description
bool

View Source

HasContentNodes(int)

Returns true or false depending on whether content nodes have been created based on the provided content type id.

Declaration

bool HasContentNodes(int id)

Parameters

Type	Name	Description
int	id

Returns

Type	Description
bool

View Source

Move(TItem, int)

Declaration

[Obsolete("Please use MoveAsync. Will be removed in V16.")]
Attempt<OperationResult<MoveOperationStatusType>?> Move(TItem moving, int containerId)

Parameters

Type	Name	Description
TItem	moving
int	containerId

Returns

Type	Description
Attempt<OperationResult<MoveOperationStatusType>>

View Source

MoveAsync(Guid, Guid?)

Declaration

Task<Attempt<TItem?, ContentTypeStructureOperationStatus>> MoveAsync(Guid key, Guid? containerKey)

Parameters

Type	Name	Description
Guid	key
Guid?	containerKey

Returns

Type	Description
Task<Attempt<TItem, ContentTypeStructureOperationStatus>>

View Source

RenameContainer(int, string, int)

Declaration

Attempt<OperationResult<OperationResultType, EntityContainer>?> RenameContainer(int id, string name, int userId = -1)

Parameters

Type	Name	Description
int	id
string	name
int	userId

Returns

Type	Description
Attempt<OperationResult<OperationResultType, EntityContainer>>

View Source

Save(IEnumerable<TItem>, int)

Declaration

[Obsolete("Please use the respective Create or Update instead")]
void Save(IEnumerable<TItem> items, int userId = -1)

Parameters

Type	Name	Description
IEnumerable<TItem>	items
int	userId

View Source

Save(TItem?, int)

Declaration

[Obsolete("Please use the respective Create or Update instead")]
void Save(TItem? item, int userId = -1)

Parameters

Type	Name	Description
TItem	item
int	userId

View Source

SaveAsync(TItem, Guid)

Declaration

[Obsolete("Please use the respective Create or Update instead")]
Task SaveAsync(TItem item, Guid performingUserKey)

Parameters

Type	Name	Description
TItem	item
Guid	performingUserKey

Returns

Type	Description
Task

View Source

SaveContainer(EntityContainer, int)

Declaration

Attempt<OperationResult?> SaveContainer(EntityContainer container, int userId = -1)

Parameters

Type	Name	Description
EntityContainer	container
int	userId

Returns

Type	Description
Attempt<OperationResult>

View Source

UpdateAsync(TItem, Guid)

Declaration

Task<Attempt<ContentTypeOperationStatus>> UpdateAsync(TItem item, Guid performingUserKey)

Parameters

Type	Name	Description
TItem	item
Guid	performingUserKey

Returns

Type	Description
Task<Attempt<ContentTypeOperationStatus>>

View Source

ValidateComposition(TItem?)

Declaration

Attempt<string[]?> ValidateComposition(TItem? compo)

Parameters

Type	Name	Description
TItem	compo

Returns

Type	Description
Attempt<string[]>