View Source

Class DataTypeService

Represents the DataType Service, which is an easy access to operations involving IDataType

Inheritance

System.Object

RepositoryService

ScopeRepositoryService

Namespace: Umbraco.Core.Services.Implement

Assembly: Umbraco.Core.dll

Syntax

public class DataTypeService : ScopeRepositoryService, IDataTypeService, IService

Constructors

View Source

DataTypeService(IScopeProvider, ILogger, IEventMessagesFactory, IDataTypeRepository, IDataTypeContainerRepository, IAuditRepository, IEntityRepository, IContentTypeRepository)

Declaration

public DataTypeService(IScopeProvider provider, ILogger logger, IEventMessagesFactory eventMessagesFactory, IDataTypeRepository dataTypeRepository, IDataTypeContainerRepository dataTypeContainerRepository, IAuditRepository auditRepository, IEntityRepository entityRepository, IContentTypeRepository contentTypeRepository)

Parameters

Type	Name	Description
IScopeProvider	provider
ILogger	logger
IEventMessagesFactory	eventMessagesFactory
IDataTypeRepository	dataTypeRepository
IDataTypeContainerRepository	dataTypeContainerRepository
IAuditRepository	auditRepository
IEntityRepository	entityRepository
IContentTypeRepository	contentTypeRepository

Methods

View Source

CreateContainer(Int32, String, Int32)

Declaration

public Attempt<OperationResult<OperationResultType, EntityContainer>> CreateContainer(int parentId, string name, int userId = -1)

Parameters

Type	Name	Description
System.Int32	parentId
System.String	name
System.Int32	userId

Returns

Type	Description
Attempt<OperationResult<OperationResultType, EntityContainer>>

View Source

Delete(IDataType, Int32)

Deletes an IDataType

Declaration

public void Delete(IDataType dataType, int userId = -1)

Parameters

Type	Name	Description
IDataType	dataType	IDataType to delete
System.Int32	userId	Optional Id of the user issuing the deletion

Remarks

Please note that deleting a IDataType will remove all the PropertyType data that references this IDataType.

View Source

DeleteContainer(Int32, Int32)

Declaration

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

Parameters

Type	Name	Description
System.Int32	containerId
System.Int32	userId

Returns

Type	Description
Attempt<OperationResult>

View Source

GetAll(Int32[])

Gets all IDataType objects or those with the ids passed in

Declaration

public IEnumerable<IDataType> GetAll(params int[] ids)

Parameters

Type	Name	Description
System.Int32[]	ids	Optional array of Ids

Returns

Type	Description
System.Collections.Generic.IEnumerable<IDataType>	An enumerable list of IDataType objects

View Source

GetByEditorAlias(String)

Gets a IDataType by its control Id

Declaration

public IEnumerable<IDataType> GetByEditorAlias(string propertyEditorAlias)

Parameters

Type	Name	Description
System.String	propertyEditorAlias	Alias of the property editor

Returns

Type	Description
System.Collections.Generic.IEnumerable<IDataType>	Collection of IDataType objects with a matching control id

View Source

GetContainer(Guid)

Declaration

public EntityContainer GetContainer(Guid containerId)

Parameters

Type	Name	Description
System.Guid	containerId

Returns

Type	Description
EntityContainer

View Source

GetContainer(Int32)

Declaration

public EntityContainer GetContainer(int containerId)

Parameters

Type	Name	Description
System.Int32	containerId

Returns

Type	Description
EntityContainer

View Source

GetContainers(Int32[])

Declaration

public IEnumerable<EntityContainer> GetContainers(int[] containerIds)

Parameters

Type	Name	Description
System.Int32[]	containerIds

Returns

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

View Source

GetContainers(String, Int32)

Declaration

public IEnumerable<EntityContainer> GetContainers(string name, int level)

Parameters

Type	Name	Description
System.String	name
System.Int32	level

Returns

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

View Source

GetContainers(IDataType)

Declaration

public IEnumerable<EntityContainer> GetContainers(IDataType dataType)

Parameters

Type	Name	Description
IDataType	dataType

Returns

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

View Source

GetDataType(Guid)

Gets a IDataType by its unique guid Id

Declaration

public IDataType GetDataType(Guid id)

Parameters

Type	Name	Description
System.Guid	id	Unique guid Id of the DataType

Returns

Type	Description
IDataType	IDataType

View Source

GetDataType(Int32)

Gets a IDataType by its Id

Declaration

public IDataType GetDataType(int id)

Parameters

Type	Name	Description
System.Int32	id	Id of the IDataType

Returns

Type	Description
IDataType	IDataType

View Source

GetDataType(String)

Gets a IDataType by its Name

Declaration

public IDataType GetDataType(string name)

Parameters

Type	Name	Description
System.String	name	Name of the IDataType

Returns

Type	Description
IDataType	IDataType

View Source

GetReferences(Int32)

Declaration

public IReadOnlyDictionary<Udi, IEnumerable<string>> GetReferences(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Collections.Generic.IReadOnlyDictionary<Udi, System.Collections.Generic.IEnumerable<System.String>>

View Source

Move(IDataType, Int32)

Declaration

public Attempt<OperationResult<MoveOperationStatusType>> Move(IDataType toMove, int parentId)

Parameters

Type	Name	Description
IDataType	toMove
System.Int32	parentId

Returns

Type	Description
Attempt<OperationResult<MoveOperationStatusType>>

View Source

RenameContainer(Int32, String, Int32)

Declaration

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

Parameters

Type	Name	Description
System.Int32	id
System.String	name
System.Int32	userId

Returns

Type	Description
Attempt<OperationResult<OperationResultType, EntityContainer>>

View Source

Save(IEnumerable<IDataType>, Int32)

Saves a collection of IDataType

Declaration

public void Save(IEnumerable<IDataType> dataTypeDefinitions, int userId = -1)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IDataType>	dataTypeDefinitions	IDataType to save
System.Int32	userId	Id of the user issuing the save

View Source

Save(IEnumerable<IDataType>, Int32, Boolean)

Saves a collection of IDataType

Declaration

public void Save(IEnumerable<IDataType> dataTypeDefinitions, int userId, bool raiseEvents)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IDataType>	dataTypeDefinitions	IDataType to save
System.Int32	userId	Id of the user issuing the save
System.Boolean	raiseEvents	Boolean indicating whether or not to raise events

View Source

Save(IDataType, Int32)

Saves an IDataType

Declaration

public void Save(IDataType dataType, int userId = -1)

Parameters

Type	Name	Description
IDataType	dataType	IDataType to save
System.Int32	userId	Id of the user issuing the save

View Source

SaveContainer(EntityContainer, Int32)

Declaration

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

Parameters

Type	Name	Description
EntityContainer	container
System.Int32	userId

Returns

Type	Description
Attempt<OperationResult>

Events

View Source

Deleted

Occurs after Delete

Declaration

public static event TypedEventHandler<IDataTypeService, DeleteEventArgs<IDataType>> Deleted

Event Type

Type	Description
TypedEventHandler<IDataTypeService, DeleteEventArgs<IDataType>>

View Source

DeletedContainer

Declaration

public static event TypedEventHandler<IDataTypeService, DeleteEventArgs<EntityContainer>> DeletedContainer

Event Type

Type	Description
TypedEventHandler<IDataTypeService, DeleteEventArgs<EntityContainer>>

View Source

Deleting

Occurs before Delete

Declaration

public static event TypedEventHandler<IDataTypeService, DeleteEventArgs<IDataType>> Deleting

Event Type

Type	Description
TypedEventHandler<IDataTypeService, DeleteEventArgs<IDataType>>

View Source

DeletingContainer

Declaration

public static event TypedEventHandler<IDataTypeService, DeleteEventArgs<EntityContainer>> DeletingContainer

Event Type

Type	Description
TypedEventHandler<IDataTypeService, DeleteEventArgs<EntityContainer>>

View Source

Moved

Occurs after Move

Declaration

public static event TypedEventHandler<IDataTypeService, MoveEventArgs<IDataType>> Moved

Event Type

Type	Description
TypedEventHandler<IDataTypeService, MoveEventArgs<IDataType>>

View Source

Moving

Occurs before Move

Declaration

public static event TypedEventHandler<IDataTypeService, MoveEventArgs<IDataType>> Moving

Event Type

Type	Description
TypedEventHandler<IDataTypeService, MoveEventArgs<IDataType>>

View Source

Saved

Occurs after Save

Declaration

public static event TypedEventHandler<IDataTypeService, SaveEventArgs<IDataType>> Saved

Event Type

Type	Description
TypedEventHandler<IDataTypeService, SaveEventArgs<IDataType>>

View Source

SavedContainer

Declaration

public static event TypedEventHandler<IDataTypeService, SaveEventArgs<EntityContainer>> SavedContainer

Event Type

Type	Description
TypedEventHandler<IDataTypeService, SaveEventArgs<EntityContainer>>

View Source

Saving

Occurs before Save

Declaration

public static event TypedEventHandler<IDataTypeService, SaveEventArgs<IDataType>> Saving

Event Type

Type	Description
TypedEventHandler<IDataTypeService, SaveEventArgs<IDataType>>

View Source

SavingContainer

Declaration

public static event TypedEventHandler<IDataTypeService, SaveEventArgs<EntityContainer>> SavingContainer

Event Type

Type	Description
TypedEventHandler<IDataTypeService, SaveEventArgs<EntityContainer>>