View Source

Class DataTypeController

The API controller used for editing data types

Inheritance

System.Object

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

UmbracoAuthorizedJsonController

BackOfficeNotificationsController

Namespace: Umbraco.Web.Editors

Assembly: Umbraco.Web.dll

Syntax

[PluginController("UmbracoApi")]
public class DataTypeController : BackOfficeNotificationsController, IDiscoverable

Remarks

The security for this controller is defined to allow full CRUD access to data types if the user has access to either: Content Types, Member Types or Media Types ... and of course to Data Types

Constructors

DataTypeController(PropertyEditorCollection, IGlobalSettings, IUmbracoContextAccessor, ISqlContext, ServiceContext, AppCaches, IProfilingLogger, IRuntimeState, UmbracoHelper)

Declaration

public DataTypeController(PropertyEditorCollection propertyEditors, IGlobalSettings globalSettings, IUmbracoContextAccessor umbracoContextAccessor, ISqlContext sqlContext, ServiceContext services, AppCaches appCaches, IProfilingLogger logger, IRuntimeState runtimeState, UmbracoHelper umbracoHelper)

Parameters

Type	Name	Description
PropertyEditorCollection	propertyEditors
IGlobalSettings	globalSettings
IUmbracoContextAccessor	umbracoContextAccessor
ISqlContext	sqlContext
ServiceContext	services
AppCaches	appCaches
IProfilingLogger	logger
IRuntimeState	runtimeState
UmbracoHelper	umbracoHelper

Methods

DeleteById(Int32)

Deletes a data type with a given ID

Declaration

public HttpResponseMessage DeleteById(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
HttpResponseMessage

DeleteContainer(Int32)

Deletes a data type container with a given ID

Declaration

public HttpResponseMessage DeleteContainer(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
HttpResponseMessage

GetAll()

Gets the content json for all data types

Declaration

public IEnumerable<DataTypeBasic> GetAll()

Returns

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

Remarks

Permission is granted to this method if the user has access to any of these sections: Content, media, settings, developer, members

GetAllPropertyEditors()

Gets all property editors defined

Declaration

public IEnumerable<PropertyEditorBasic> GetAllPropertyEditors()

Returns

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

Remarks

Permission is granted to this method if the user has access to any of these sections: Content, media, settings, developer, members

GetById(Guid)

Gets the datatype json for the datatype guid

Declaration

public DataTypeDisplay GetById(Guid id)

Parameters

Type	Name	Description
System.Guid	id

Returns

Type	Description
DataTypeDisplay

GetById(Int32)

Gets the datatype json for the datatype id

Declaration

public DataTypeDisplay GetById(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
DataTypeDisplay

GetById(Udi)

Gets the datatype json for the datatype udi

Declaration

public DataTypeDisplay GetById(Udi id)

Parameters

Type	Name	Description
Udi	id

Returns

Type	Description
DataTypeDisplay

GetByName(String)

Gets data type by name

Declaration

public DataTypeDisplay GetByName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
DataTypeDisplay

GetCustomListView(String)

Returns a custom listview, based on a content type alias, if found

Declaration

public DataTypeDisplay GetCustomListView(string contentTypeAlias)

Parameters

Type	Name	Description
System.String	contentTypeAlias

Returns

Type	Description
DataTypeDisplay	a DataTypeDisplay

GetEmpty(Int32)

Declaration

public DataTypeDisplay GetEmpty(int parentId)

Parameters

Type	Name	Description
System.Int32	parentId

Returns

Type	Description
DataTypeDisplay

GetGroupedDataTypes()

Returns all data types grouped by their property editor group

Declaration

public IDictionary<string, IEnumerable<DataTypeBasic>> GetGroupedDataTypes()

Returns

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Collections.Generic.IEnumerable<DataTypeBasic>>

Remarks

Permission is granted to this method if the user has access to any of these sections: Content, media, settings, developer, members

GetGroupedPropertyEditors()

Returns all property editors grouped

Declaration

public IDictionary<string, IEnumerable<DataTypeBasic>> GetGroupedPropertyEditors()

Returns

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Collections.Generic.IEnumerable<DataTypeBasic>>

Remarks

Permission is granted to this method if the user has access to any of these sections: Content, media, settings, developer, members

GetPreValues(String, Int32)

Returns the pre-values for the specified property editor

Declaration

public IEnumerable<DataTypeConfigurationFieldDisplay> GetPreValues(string editorAlias, int dataTypeId = -1)

Parameters

Type	Name	Description
System.String	editorAlias
System.Int32	dataTypeId	The data type id for the pre-values, -1 if it is a new data type

Returns

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

GetReferences(Int32)

Returns the references (usages) for the data type

Declaration

public DataTypeReferences GetReferences(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
DataTypeReferences

PostCreateContainer(Int32, String)

Declaration

public HttpResponseMessage PostCreateContainer(int parentId, string name)

Parameters

Type	Name	Description
System.Int32	parentId
System.String	name

Returns

Type	Description
HttpResponseMessage

PostCreateCustomListView(String)

Creates a custom list view - give a document type alias

Declaration

public DataTypeDisplay PostCreateCustomListView(string contentTypeAlias)

Parameters

Type	Name	Description
System.String	contentTypeAlias

Returns

Type	Description
DataTypeDisplay

PostMove(MoveOrCopy)

Move the media type

Declaration

public HttpResponseMessage PostMove(MoveOrCopy move)

Parameters

Type	Name	Description
MoveOrCopy	move

Returns

Type	Description
HttpResponseMessage

PostRenameContainer(Int32, String)

Declaration

public HttpResponseMessage PostRenameContainer(int id, string name)

Parameters

Type	Name	Description
System.Int32	id
System.String	name

Returns

Type	Description
HttpResponseMessage

PostSave(DataTypeSave)

Saves the data type

Declaration

public DataTypeDisplay PostSave(DataTypeSave dataType)

Parameters

Type	Name	Description
DataTypeSave	dataType

Returns

Type	Description
DataTypeDisplay