View Source

Class ByKeyDocumentCollectionController

Inheritance

System.Object

ManagementApiControllerBase

ContentCollectionControllerBase<IContent, DocumentCollectionResponseModel, DocumentValueResponseModel, DocumentVariantResponseModel>

DocumentCollectionControllerBase

Namespace: Umbraco.Cms.Api.Management.Controllers.Document.Collection

Assembly: Umbraco.Cms.Api.Management.dll

Syntax

public class ByKeyDocumentCollectionController : DocumentCollectionControllerBase

Constructors

ByKeyDocumentCollectionController(IContentListViewService, IBackOfficeSecurityAccessor, IUmbracoMapper)

Declaration

public ByKeyDocumentCollectionController(IContentListViewService contentListViewService, IBackOfficeSecurityAccessor backOfficeSecurityAccessor, IUmbracoMapper mapper)

Parameters

Type	Name	Description
IContentListViewService	contentListViewService
IBackOfficeSecurityAccessor	backOfficeSecurityAccessor
IUmbracoMapper	mapper

ByKeyDocumentCollectionController(IContentListViewService, IBackOfficeSecurityAccessor, IUmbracoMapper, IDocumentCollectionPresentationFactory)

Declaration

public ByKeyDocumentCollectionController(IContentListViewService contentListViewService, IBackOfficeSecurityAccessor backOfficeSecurityAccessor, IUmbracoMapper mapper, IDocumentCollectionPresentationFactory documentCollectionPresentationFactory)

Parameters

Type	Name	Description
IContentListViewService	contentListViewService
IBackOfficeSecurityAccessor	backOfficeSecurityAccessor
IUmbracoMapper	mapper
IDocumentCollectionPresentationFactory	documentCollectionPresentationFactory

Methods

ByKey(CancellationToken, Guid, Nullable<Guid>, String, String, Direction, String, Int32, Int32)

Declaration

public async Task<IActionResult> ByKey(CancellationToken cancellationToken, Guid id, Guid? dataTypeId = null, string orderBy = "updateDate", string orderCulture = null, Direction orderDirection = null, string filter = null, int skip = 0, int take = 100)

Parameters

Type	Name	Description
CancellationToken	cancellationToken
Guid	id
System.Nullable<Guid>	dataTypeId
System.String	orderBy
System.String	orderCulture
Direction	orderDirection
System.String	filter
System.Int32	skip
System.Int32	take

Returns

Type	Description
Task<IActionResult>