Class DocsDocumentController

Inheritance
object
ControllerBase
Controller
AbpController
DocsDocumentController
Implements
Inherited Members
Namespace: Volo.Docs.Documents
Assembly: Volo.Docs.HttpApi.dll
Syntax
[RemoteService(true, Name = "AbpDocs")]
[Area("docs")]
[Route("api/docs/documents")]
public class DocsDocumentController : AbpController, IActionFilter, IAsyncActionFilter, IFilterMetadata, IDisposable, IAvoidDuplicateCrossCuttingConcerns, IDocumentAppService, IApplicationService, IRemoteService

Constructors

DocsDocumentController(IDocumentAppService)

Declaration
public DocsDocumentController(IDocumentAppService documentAppService)
Parameters
Type Name Description
IDocumentAppService documentAppService

Properties

DocumentAppService

Declaration
protected IDocumentAppService DocumentAppService { get; }
Property Value
Type Description
IDocumentAppService

Methods

FullSearchEnabledAsync()

Declaration
[HttpGet]
[Route("full-search-enabled")]
public Task<bool> FullSearchEnabledAsync()
Returns
Type Description
Task<bool>

GetAsync(GetDocumentInput)

Declaration
[HttpGet]
[Route("")]
public virtual Task<DocumentWithDetailsDto> GetAsync(GetDocumentInput input)
Parameters
Type Name Description
GetDocumentInput input
Returns
Type Description
Task<DocumentWithDetailsDto>

GetDefaultAsync(GetDefaultDocumentInput)

Declaration
[HttpGet]
[Route("default")]
public virtual Task<DocumentWithDetailsDto> GetDefaultAsync(GetDefaultDocumentInput input)
Parameters
Type Name Description
GetDefaultDocumentInput input
Returns
Type Description
Task<DocumentWithDetailsDto>

GetNavigationAsync(GetNavigationDocumentInput)

Declaration
[HttpGet]
[Route("navigation")]
public Task<NavigationNode> GetNavigationAsync(GetNavigationDocumentInput input)
Parameters
Type Name Description
GetNavigationDocumentInput input
Returns
Type Description
Task<NavigationNode>

GetParametersAsync(GetParametersDocumentInput)

Declaration
[HttpGet]
[Route("parameters")]
public Task<DocumentParametersDto> GetParametersAsync(GetParametersDocumentInput input)
Parameters
Type Name Description
GetParametersDocumentInput input
Returns
Type Description
Task<DocumentParametersDto>

GetResourceAsync(GetDocumentResourceInput)

Declaration
[HttpGet]
[Route("resource")]
public Task<DocumentResourceDto> GetResourceAsync(GetDocumentResourceInput input)
Parameters
Type Name Description
GetDocumentResourceInput input
Returns
Type Description
Task<DocumentResourceDto>

GetUrlsAsync(string)

Declaration
[HttpGet]
[Route("links")]
public Task<List<string>> GetUrlsAsync(string prefix)
Parameters
Type Name Description
string prefix
Returns
Type Description
Task<List<string>>

SearchAsync(DocumentSearchInput)

Declaration
[HttpPost]
[Route("search")]
public Task<PagedResultDto<DocumentSearchOutput>> SearchAsync(DocumentSearchInput input)
Parameters
Type Name Description
DocumentSearchInput input
Returns
Type Description
Task<PagedResultDto<DocumentSearchOutput>>

Implements

Extension Methods