View Source

Class MediaTypeController

An API controller used for dealing with content types

Inheritance

System.Object

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

UmbracoAuthorizedJsonController

ContentTypeControllerBase<IMediaType>

Namespace: Umbraco.Web.Editors

Assembly: Umbraco.Web.dll

Syntax

[PluginController("UmbracoApi")]
public class MediaTypeController : ContentTypeControllerBase<IMediaType>, IDiscoverable

Constructors

MediaTypeController(ICultureDictionaryFactory, IGlobalSettings, IUmbracoContextAccessor, ISqlContext, ServiceContext, AppCaches, IProfilingLogger, IRuntimeState, UmbracoHelper)

Declaration

public MediaTypeController(ICultureDictionaryFactory cultureDictionaryFactory, IGlobalSettings globalSettings, IUmbracoContextAccessor umbracoContextAccessor, ISqlContext sqlContext, ServiceContext services, AppCaches appCaches, IProfilingLogger logger, IRuntimeState runtimeState, UmbracoHelper umbracoHelper)

Parameters

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

Methods

DeleteById(Int32)

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

Declaration

public HttpResponseMessage DeleteContainer(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
HttpResponseMessage

GetAll()

Returns all media types

Declaration

public IEnumerable<ContentTypeBasic> GetAll()

Returns

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

GetAllowedChildren(Guid)

Returns the allowed child content type objects for the content item id passed in - based on a GUID id

Declaration

public IEnumerable<ContentTypeBasic> GetAllowedChildren(Guid contentId)

Parameters

Type	Name	Description
System.Guid	contentId

Returns

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

GetAllowedChildren(Int32)

Returns the allowed child content type objects for the content item id passed in - based on an INT id

Declaration

public IEnumerable<ContentTypeBasic> GetAllowedChildren(int contentId)

Parameters

Type	Name	Description
System.Int32	contentId

Returns

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

GetAllowedChildren(Udi)

Returns the allowed child content type objects for the content item id passed in - based on a UDI id

Declaration

public IEnumerable<ContentTypeBasic> GetAllowedChildren(Udi contentId)

Parameters

Type	Name	Description
Udi	contentId

Returns

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

GetAvailableCompositeMediaTypes(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 GetAvailableCompositeMediaTypes(GetAvailableCompositionsFilter filter)

Parameters

Type	Name	Description
GetAvailableCompositionsFilter	filter	Filter applied when resolving compositions

Returns

Type	Description
HttpResponseMessage

GetById(Guid)

Gets the media type a given guid

Declaration

public MediaTypeDisplay GetById(Guid id)

Parameters

Type	Name	Description
System.Guid	id

Returns

Type	Description
MediaTypeDisplay

GetById(Int32)

Gets the media type a given id

Declaration

public MediaTypeDisplay GetById(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
MediaTypeDisplay

GetById(Udi)

Gets the media type a given udi

Declaration

public MediaTypeDisplay GetById(Udi id)

Parameters

Type	Name	Description
Udi	id

Returns

Type	Description
MediaTypeDisplay

GetCount()

Declaration

public int GetCount()

Returns

Type	Description
System.Int32

GetEmpty(Int32)

Declaration

public MediaTypeDisplay GetEmpty(int parentId)

Parameters

Type	Name	Description
System.Int32	parentId

Returns

Type	Description
MediaTypeDisplay

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

PostCopy(MoveOrCopy)

Copy the media 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

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(MediaTypeSave)

Declaration

public MediaTypeDisplay PostSave(MediaTypeSave contentTypeSave)

Parameters

Type	Name	Description
MediaTypeSave	contentTypeSave

Returns

Type	Description
MediaTypeDisplay