View Source

Class MediaController

Inheritance

System.Object

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

UmbracoAuthorizedJsonController

BackOfficeNotificationsController

ContentControllerBase

Namespace: Umbraco.Web.Editors

Assembly: Umbraco.Web.dll

Syntax

[PluginController("UmbracoApi")]
public class MediaController : ContentControllerBase, IDiscoverable

Remarks

This controller is decorated with the UmbracoApplicationAuthorizeAttribute which means that any user requesting access to ALL of the methods on this controller will need access to the media application.

Constructors

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

Declaration

public MediaController(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

Properties

UserStartNodes

Declaration

protected int[] UserStartNodes { get; }

Property Value

Type	Description
System.Int32[]

Methods

DeleteById(Int32)

Moves an item to the recycle bin, if it is already there then it will permanently delete it

Declaration

public HttpResponseMessage DeleteById(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
HttpResponseMessage

EmptyRecycleBin()

Empties the recycle bin

Declaration

public HttpResponseMessage EmptyRecycleBin()

Returns

Type	Description
HttpResponseMessage

GetById(Guid)

Gets the media item by id

Declaration

public MediaItemDisplay GetById(Guid id)

Parameters

Type	Name	Description
System.Guid	id

Returns

Type	Description
MediaItemDisplay

GetById(Int32)

Gets the media item by id

Declaration

public MediaItemDisplay GetById(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
MediaItemDisplay

GetById(Udi)

Gets the media item by id

Declaration

public MediaItemDisplay GetById(Udi id)

Parameters

Type	Name	Description
Udi	id

Returns

Type	Description
MediaItemDisplay

GetByIds(Int32[])

Return media for the specified ids

Declaration

public IEnumerable<MediaItemDisplay> GetByIds(int[] ids)

Parameters

Type	Name	Description
System.Int32[]	ids

Returns

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

GetChildFolders(Int32, Int32, Int32)

Returns a paged result of media items known to be of a "Folder" type

Declaration

public PagedResult<ContentItemBasic<ContentPropertyBasic>> GetChildFolders(int id, int pageNumber = 1, int pageSize = 1000)

Parameters

Type	Name	Description
System.Int32	id
System.Int32	pageNumber
System.Int32	pageSize

Returns

Type	Description
PagedResult<ContentItemBasic<ContentPropertyBasic>>

GetChildren(Guid, Int32, Int32, String, Direction, Boolean, String)

Returns the child media objects - using the entity GUID id

Declaration

public PagedResult<ContentItemBasic<ContentPropertyBasic>> GetChildren(Guid id, int pageNumber = 0, int pageSize = 0, string orderBy = "SortOrder", Direction orderDirection = Direction.Ascending, bool orderBySystemField = true, string filter = "")

Parameters

Type	Name	Description
System.Guid	id
System.Int32	pageNumber
System.Int32	pageSize
System.String	orderBy
Direction	orderDirection
System.Boolean	orderBySystemField
System.String	filter

Returns

Type	Description
PagedResult<ContentItemBasic<ContentPropertyBasic>>

GetChildren(Int32, Int32, Int32, String, Direction, Boolean, String)

Returns the child media objects - using the entity INT id

Declaration

public PagedResult<ContentItemBasic<ContentPropertyBasic>> GetChildren(int id, int pageNumber = 0, int pageSize = 0, string orderBy = "SortOrder", Direction orderDirection = Direction.Ascending, bool orderBySystemField = true, string filter = "")

Parameters

Type	Name	Description
System.Int32	id
System.Int32	pageNumber
System.Int32	pageSize
System.String	orderBy
Direction	orderDirection
System.Boolean	orderBySystemField
System.String	filter

Returns

Type	Description
PagedResult<ContentItemBasic<ContentPropertyBasic>>

GetChildren(Udi, Int32, Int32, String, Direction, Boolean, String)

Returns the child media objects - using the entity UDI id

Declaration

public PagedResult<ContentItemBasic<ContentPropertyBasic>> GetChildren(Udi id, int pageNumber = 0, int pageSize = 0, string orderBy = "SortOrder", Direction orderDirection = Direction.Ascending, bool orderBySystemField = true, string filter = "")

Parameters

Type	Name	Description
Udi	id
System.Int32	pageNumber
System.Int32	pageSize
System.String	orderBy
Direction	orderDirection
System.Boolean	orderBySystemField
System.String	filter

Returns

Type	Description
PagedResult<ContentItemBasic<ContentPropertyBasic>>

GetEmpty(String, Int32)

Gets an empty content item for the

Declaration

public MediaItemDisplay GetEmpty(string contentTypeAlias, int parentId)

Parameters

Type	Name	Description
System.String	contentTypeAlias
System.Int32	parentId

Returns

Type	Description
MediaItemDisplay

GetPagedReferences(Int32, String, Int32, Int32)

Declaration

public PagedResult<EntityBasic> GetPagedReferences(int id, string entityType, int pageNumber = 1, int pageSize = 100)

Parameters

Type	Name	Description
System.Int32	id
System.String	entityType
System.Int32	pageNumber
System.Int32	pageSize

Returns

Type	Description
PagedResult<EntityBasic>

GetRecycleBin()

Returns an item to be used to display the recycle bin for media

Declaration

public MediaItemDisplay GetRecycleBin()

Returns

Type	Description
MediaItemDisplay

GetRootMedia()

Returns the root media objects

Declaration

public IEnumerable<ContentItemBasic<ContentPropertyBasic>> GetRootMedia()

Returns

Type	Description
System.Collections.Generic.IEnumerable<ContentItemBasic<ContentPropertyBasic>>

PostAddFile()

Used to submit a media file

Declaration

public async Task<HttpResponseMessage> PostAddFile()

Returns

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

Remarks

We cannot validate this request with attributes (nicely) due to the nature of the multi-part for data.

PostAddFolder(PostedFolder)

Declaration

public MediaItemDisplay PostAddFolder(PostedFolder folder)

Parameters

Type	Name	Description
PostedFolder	folder

Returns

Type	Description
MediaItemDisplay

PostMove(MoveOrCopy)

Change the sort order for media

Declaration

public HttpResponseMessage PostMove(MoveOrCopy move)

Parameters

Type	Name	Description
MoveOrCopy	move

Returns

Type	Description
HttpResponseMessage

PostSave(MediaItemSave)

Saves content

Declaration

public MediaItemDisplay PostSave(MediaItemSave contentItem)

Parameters

Type	Name	Description
MediaItemSave	contentItem

Returns

Type	Description
MediaItemDisplay

PostSort(ContentSortOrder)

Change the sort order for media

Declaration

public HttpResponseMessage PostSort(ContentSortOrder sorted)

Parameters

Type	Name	Description
ContentSortOrder	sorted

Returns

Type	Description
HttpResponseMessage