View Source

Class SearchDocumentItemController

Inheritance

System.Object

ManagementApiControllerBase

DocumentItemControllerBase

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

Assembly: Umbraco.Cms.Api.Management.dll

Syntax

public class SearchDocumentItemController : DocumentItemControllerBase

Constructors

SearchDocumentItemController(IIndexedEntitySearchService, IDocumentPresentationFactory)

Declaration

public SearchDocumentItemController(IIndexedEntitySearchService indexedEntitySearchService, IDocumentPresentationFactory documentPresentationFactory)

Parameters

Type	Name	Description
IIndexedEntitySearchService	indexedEntitySearchService
IDocumentPresentationFactory	documentPresentationFactory

Methods

Search(CancellationToken, String, Int32, Int32)

Declaration

public async Task<IActionResult> Search(CancellationToken cancellationToken, string query, int skip = 0, int take = 100)

Parameters

Type	Name	Description
CancellationToken	cancellationToken
System.String	query
System.Int32	skip
System.Int32	take

Returns

Type	Description
Task<IActionResult>

SearchFromParent(CancellationToken, String, Int32, Int32, Nullable<Guid>)

Declaration

public async Task<IActionResult> SearchFromParent(CancellationToken cancellationToken, string query, int skip = 0, int take = 100, Guid? parentId = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken
System.String	query
System.Int32	skip
System.Int32	take
System.Nullable<Guid>	parentId

Returns

Type	Description
Task<IActionResult>

SearchFromParentWithAllowedTypes(CancellationToken, String, Int32, Int32, Nullable<Guid>, Nullable<IEnumerable<Guid>>)

Declaration

public async Task<IActionResult> SearchFromParentWithAllowedTypes(CancellationToken cancellationToken, string query, int skip = 0, int take = 100, Guid? parentId = null, IEnumerable<Guid>? allowedDocumentTypes = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken
System.String	query
System.Int32	skip
System.Int32	take
System.Nullable<Guid>	parentId
System.Nullable<IEnumerable<Guid>>	allowedDocumentTypes

Returns

Type	Description
Task<IActionResult>

SearchWithTrashed(CancellationToken, String, Nullable<Boolean>, Int32, Int32, Nullable<Guid>, Nullable<IEnumerable<Guid>>)

Declaration

public async Task<IActionResult> SearchWithTrashed(CancellationToken cancellationToken, string query, bool? trashed = null, int skip = 0, int take = 100, Guid? parentId = null, IEnumerable<Guid>? allowedDocumentTypes = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken
System.String	query
System.Nullable<System.Boolean>	trashed
System.Int32	skip
System.Int32	take
System.Nullable<Guid>	parentId
System.Nullable<IEnumerable<Guid>>	allowedDocumentTypes

Returns

Type	Description
Task<IActionResult>