Class DocumentsAdminController
Implements
Inherited Members
Namespace: Volo.Docs.Admin
Assembly: Volo.Docs.Admin.HttpApi.dll
Syntax
[RemoteService(true, Name = "AbpDocsAdmin")]
[Area("docs-admin")]
[Route("api/docs/admin/documents")]
public class DocumentsAdminController : AbpControllerBase, IAvoidDuplicateCrossCuttingConcerns, IDocumentAdminAppService, IApplicationService, IRemoteService
Constructors
DocumentsAdminController(IDocumentAdminAppService)
Declaration
public DocumentsAdminController(IDocumentAdminAppService documentAdminAppService)
Parameters
Type | Name | Description |
---|---|---|
IDocumentAdminAppService | documentAdminAppService |
Methods
ClearCacheAsync(ClearCacheInput)
Declaration
[HttpPost]
[Route("ClearCache")]
public Task ClearCacheAsync(ClearCacheInput input)
Parameters
Type | Name | Description |
---|---|---|
ClearCacheInput | input |
Returns
Type | Description |
---|---|
Task |
GetAllAsync(GetAllInput)
Declaration
[HttpGet]
[Route("GetAll")]
public Task<PagedResultDto<DocumentDto>> GetAllAsync(GetAllInput input)
Parameters
Type | Name | Description |
---|---|---|
GetAllInput | input |
Returns
Type | Description |
---|---|
Task<PagedResultDto<DocumentDto>> |
GetFilterItemsAsync()
Declaration
[HttpGet]
[Route("GetFilterItems")]
public virtual Task<List<DocumentInfoDto>> GetFilterItemsAsync()
Returns
Type | Description |
---|---|
Task<List<DocumentInfoDto>> |
PullAllAsync(PullAllDocumentInput)
Declaration
[HttpPost]
[Route("PullAll")]
public Task PullAllAsync(PullAllDocumentInput input)
Parameters
Type | Name | Description |
---|---|---|
PullAllDocumentInput | input |
Returns
Type | Description |
---|---|
Task |
PullAsync(PullDocumentInput)
Declaration
[HttpPost]
[Route("Pull")]
public Task PullAsync(PullDocumentInput input)
Parameters
Type | Name | Description |
---|---|---|
PullDocumentInput | input |
Returns
Type | Description |
---|---|
Task |
ReindexAsync(Guid)
Declaration
[HttpPut]
[Route("ReindexDocument")]
public virtual Task ReindexAsync(Guid documentId)
Parameters
Type | Name | Description |
---|---|---|
Guid | documentId |
Returns
Type | Description |
---|---|
Task |
RemoveFromCacheAsync(Guid)
Declaration
[HttpPut]
[Route("RemoveDocumentFromCache")]
public virtual Task RemoveFromCacheAsync(Guid documentId)
Parameters
Type | Name | Description |
---|---|---|
Guid | documentId |
Returns
Type | Description |
---|---|
Task |