Class DataTypeService

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

Inheritance

System.Object

RepositoryService

Namespace: Umbraco.Cms.Core.Services.Implement

Assembly: cs.temp.dll.dll

Syntax

public class DataTypeService : RepositoryService

Constructors

DataTypeService(IDataValueEditorFactory, IScopeProvider, ILoggerFactory, IEventMessagesFactory, IDataTypeRepository, IDataTypeContainerRepository, IAuditRepository, IEntityRepository, IContentTypeRepository, IIOHelper, ILocalizedTextService, ILocalizationService, IShortStringHelper, IJsonSerializer)

Declaration

public DataTypeService(IDataValueEditorFactory dataValueEditorFactory, IScopeProvider provider, ILoggerFactory loggerFactory, IEventMessagesFactory eventMessagesFactory, IDataTypeRepository dataTypeRepository, IDataTypeContainerRepository dataTypeContainerRepository, IAuditRepository auditRepository, IEntityRepository entityRepository, IContentTypeRepository contentTypeRepository, IIOHelper ioHelper, ILocalizedTextService localizedTextService, ILocalizationService localizationService, IShortStringHelper shortStringHelper, IJsonSerializer jsonSerializer)

Parameters

Type	Name	Description
IDataValueEditorFactory	dataValueEditorFactory
IScopeProvider	provider
ILoggerFactory	loggerFactory
IEventMessagesFactory	eventMessagesFactory
IDataTypeRepository	dataTypeRepository
IDataTypeContainerRepository	dataTypeContainerRepository
IAuditRepository	auditRepository
IEntityRepository	entityRepository
IContentTypeRepository	contentTypeRepository
IIOHelper	ioHelper
ILocalizedTextService	localizedTextService
ILocalizationService	localizationService
IShortStringHelper	shortStringHelper
IJsonSerializer	jsonSerializer

Methods

CreateContainer(Int32, Guid, String, Int32)

Declaration

public Attempt<OperationResult<OperationResultType, EntityContainer>> CreateContainer(int parentId, Guid key, string name, int userId = default(int))

Parameters

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

Returns

Type	Description
Attempt<OperationResult<OperationResultType, EntityContainer>>

Delete(IDataType, Int32)

Deletes an

Declaration

public void Delete(IDataType dataType, int userId = default(int))

Parameters

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

Remarks

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

DeleteContainer(Int32, Int32)

Declaration

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

Parameters

Type	Name	Description
System.Int32	containerId
System.Int32	userId

Returns

Type	Description
Attempt<OperationResult>

GetAll(Int32[])

Gets all 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 objects

GetByEditorAlias(String)

Gets a 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 objects with a matching control id

GetContainer(Guid)

Declaration

public EntityContainer GetContainer(Guid containerId)

Parameters

Type	Name	Description
System.Guid	containerId

Returns

Type	Description
EntityContainer

GetContainer(Int32)

Declaration

public EntityContainer GetContainer(int containerId)

Parameters

Type	Name	Description
System.Int32	containerId

Returns

Type	Description
EntityContainer

GetContainers(IDataType)

Declaration

public IEnumerable<EntityContainer> GetContainers(IDataType dataType)

Parameters

Type	Name	Description
IDataType	dataType

Returns

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

GetContainers(Int32[])

Declaration

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

Parameters

Type	Name	Description
System.Int32[]	containerIds

Returns

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

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>

GetDataType(Guid)

Gets a 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

GetDataType(Int32)

Gets a by its Id

Declaration

public IDataType GetDataType(int id)

Parameters

Type	Name	Description
System.Int32	id	Id of the

Returns

Type	Description
IDataType

GetDataType(String)

Gets a by its Name

Declaration

public IDataType GetDataType(string name)

Parameters

Type	Name	Description
System.String	name	Name of the

Returns

Type	Description
IDataType

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>>

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>>

RenameContainer(Int32, String, Int32)

Declaration

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

Parameters

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

Returns

Type	Description
Attempt<OperationResult<OperationResultType, EntityContainer>>

Save(IDataType, Int32)

Saves an

Declaration

public void Save(IDataType dataType, int userId = default(int))

Parameters

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

Save(IEnumerable<IDataType>, Int32)

Saves a collection of

Declaration

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

Parameters

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

SaveContainer(EntityContainer, Int32)

Declaration

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

Parameters

Type	Name	Description
EntityContainer	container
System.Int32	userId

Returns

Type	Description
Attempt<OperationResult>