Interface IDocumentAppService

Namespace: Volo.Docs.Documents
Assembly: Volo.Docs.Application.Contracts.dll
Syntax
public interface IDocumentAppService : IApplicationService, IRemoteService

Methods

FullSearchEnabledAsync()

Declaration
Task<bool> FullSearchEnabledAsync()
Returns
Type Description
Task<bool>

GetAsync(GetDocumentInput)

Declaration
Task<DocumentWithDetailsDto> GetAsync(GetDocumentInput input)
Parameters
Type Name Description
GetDocumentInput input
Returns
Type Description
Task<DocumentWithDetailsDto>

GetDefaultAsync(GetDefaultDocumentInput)

Declaration
Task<DocumentWithDetailsDto> GetDefaultAsync(GetDefaultDocumentInput input)
Parameters
Type Name Description
GetDefaultDocumentInput input
Returns
Type Description
Task<DocumentWithDetailsDto>

GetNavigationAsync(GetNavigationDocumentInput)

Declaration
Task<NavigationNode> GetNavigationAsync(GetNavigationDocumentInput input)
Parameters
Type Name Description
GetNavigationDocumentInput input
Returns
Type Description
Task<NavigationNode>

GetParametersAsync(GetParametersDocumentInput)

Declaration
Task<DocumentParametersDto> GetParametersAsync(GetParametersDocumentInput input)
Parameters
Type Name Description
GetParametersDocumentInput input
Returns
Type Description
Task<DocumentParametersDto>

GetResourceAsync(GetDocumentResourceInput)

Declaration
Task<DocumentResourceDto> GetResourceAsync(GetDocumentResourceInput input)
Parameters
Type Name Description
GetDocumentResourceInput input
Returns
Type Description
Task<DocumentResourceDto>

GetUrlsAsync(string)

Declaration
Task<List<string>> GetUrlsAsync(string prefix)
Parameters
Type Name Description
string prefix
Returns
Type Description
Task<List<string>>

SearchAsync(DocumentSearchInput)

Declaration
Task<PagedResultDto<DocumentSearchOutput>> SearchAsync(DocumentSearchInput input)
Parameters
Type Name Description
DocumentSearchInput input
Returns
Type Description
Task<PagedResultDto<DocumentSearchOutput>>

Extension Methods