View Source

Class ContentTypeController

An API controller used for dealing with content types

Inheritance

System.Object

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

UmbracoAuthorizedJsonController

ContentTypeControllerBase<IContentType>

Namespace: Umbraco.Web.Editors

Assembly: Umbraco.Web.dll

Syntax

[PluginController("UmbracoApi")]
public class ContentTypeController : ContentTypeControllerBase<IContentType>, IDiscoverable

Constructors

ContentTypeController(IEntityXmlSerializer, ICultureDictionaryFactory, IGlobalSettings, IUmbracoContextAccessor, ISqlContext, PropertyEditorCollection, ServiceContext, AppCaches, IProfilingLogger, IRuntimeState, UmbracoHelper, IScopeProvider)

Declaration

public ContentTypeController(IEntityXmlSerializer serializer, ICultureDictionaryFactory cultureDictionaryFactory, IGlobalSettings globalSettings, IUmbracoContextAccessor umbracoContextAccessor, ISqlContext sqlContext, PropertyEditorCollection propertyEditors, ServiceContext services, AppCaches appCaches, IProfilingLogger logger, IRuntimeState runtimeState, UmbracoHelper umbracoHelper, IScopeProvider scopeProvider)

Parameters

Type	Name	Description
IEntityXmlSerializer	serializer
ICultureDictionaryFactory	cultureDictionaryFactory
IGlobalSettings	globalSettings
IUmbracoContextAccessor	umbracoContextAccessor
ISqlContext	sqlContext
PropertyEditorCollection	propertyEditors
ServiceContext	services
AppCaches	appCaches
IProfilingLogger	logger
IRuntimeState	runtimeState
UmbracoHelper	umbracoHelper
IScopeProvider	scopeProvider

Methods

DeleteById(Int32)

Deletes a document 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 document type container with a given ID

Declaration

public HttpResponseMessage DeleteContainer(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
HttpResponseMessage

Export(Int32)

Declaration

public HttpResponseMessage Export(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
HttpResponseMessage

GetAll()

Returns all content type objects

Declaration

public IEnumerable<ContentTypeBasic> GetAll()

Returns

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

GetAllowedChildren(Int32)

Returns the allowed child content type objects for the content item id passed in

Declaration

public IEnumerable<ContentTypeBasic> GetAllowedChildren(int contentId)

Parameters

Type	Name	Description
System.Int32	contentId

Returns

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

GetAllPropertyTypeAliases()

Gets all user defined properties.

Declaration

public IEnumerable<string> GetAllPropertyTypeAliases()

Returns

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

GetAllStandardFields()

Gets all the standard fields.

Declaration

public IEnumerable<string> GetAllStandardFields()

Returns

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

GetAvailableCompositeContentTypes(GetAvailableCompositionsFilter)

Returns the available compositions for this content type This has been wrapped in a dto instead of simple parameters to support having multiple parameters in post request body

Declaration

public HttpResponseMessage GetAvailableCompositeContentTypes(GetAvailableCompositionsFilter filter)

Parameters

Type	Name	Description
GetAvailableCompositionsFilter	filter

Returns

Type	Description
HttpResponseMessage

GetById(Guid)

Gets the document type a given guid

Declaration

public DocumentTypeDisplay GetById(Guid id)

Parameters

Type	Name	Description
System.Guid	id

Returns

Type	Description
DocumentTypeDisplay

GetById(Int32)

Gets the document type a given id

Declaration

public DocumentTypeDisplay GetById(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
DocumentTypeDisplay

GetById(Udi)

Gets the document type a given udi

Declaration

public DocumentTypeDisplay GetById(Udi id)

Parameters

Type	Name	Description
Udi	id

Returns

Type	Description
DocumentTypeDisplay

GetCount()

Declaration

public int GetCount()

Returns

Type	Description
System.Int32

GetEmpty(Int32)

Returns an empty content type for use as a scaffold when creating a new type

Declaration

public DocumentTypeDisplay GetEmpty(int parentId)

Parameters

Type	Name	Description
System.Int32	parentId

Returns

Type	Description
DocumentTypeDisplay

GetPropertyTypeScaffold(Int32)

Declaration

public ContentPropertyDisplay GetPropertyTypeScaffold(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
ContentPropertyDisplay

GetWhereCompositionIsUsedInContentTypes(GetAvailableCompositionsFilter)

Returns where a particular composition has been used This has been wrapped in a dto instead of simple parameters to support having multiple parameters in post request body

Declaration

public HttpResponseMessage GetWhereCompositionIsUsedInContentTypes(GetAvailableCompositionsFilter filter)

Parameters

Type	Name	Description
GetAvailableCompositionsFilter	filter

Returns

Type	Description
HttpResponseMessage

HasContentNodes(Int32)

Declaration

public bool HasContentNodes(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Boolean

Import(String)

Declaration

public HttpResponseMessage Import(string file)

Parameters

Type	Name	Description
System.String	file

Returns

Type	Description
HttpResponseMessage

PostCopy(MoveOrCopy)

Copy the content type

Declaration

public HttpResponseMessage PostCopy(MoveOrCopy copy)

Parameters

Type	Name	Description
MoveOrCopy	copy

Returns

Type	Description
HttpResponseMessage

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

PostCreateDefaultTemplate(Int32)

Declaration

public TemplateDisplay PostCreateDefaultTemplate(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
TemplateDisplay

PostMove(MoveOrCopy)

Move the content 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(DocumentTypeSave)

Declaration

public DocumentTypeDisplay PostSave(DocumentTypeSave contentTypeSave)

Parameters

Type	Name	Description
DocumentTypeSave	contentTypeSave

Returns

Type	Description
DocumentTypeDisplay

Upload()

Declaration

public async Task<ContentTypeImportModel> Upload()

Returns

Type	Description
System.Threading.Tasks.Task<ContentTypeImportModel>