Class DocumentAppService

Inheritance
object
ApplicationService
DocsAppServiceBase
DocumentAppService
Implements
Inherited Members
Namespace: Volo.Docs.Documents
Assembly: Volo.Docs.Application.dll
Syntax
public class DocumentAppService : DocsAppServiceBase, IAvoidDuplicateCrossCuttingConcerns, IValidationEnabled, IUnitOfWorkEnabled, IAuditingEnabled, IGlobalFeatureCheckingEnabled, ITransientDependency, IDocumentAppService, IApplicationService, IRemoteService

Constructors

DocumentAppService(IProjectRepository, IDocumentRepository, IDocumentSourceFactory, IDistributedCache<DocumentResource>, IDistributedCache<DocumentUpdateInfo>, IHostEnvironment, IDocumentFullSearch, IOptions<DocsElasticSearchOptions>, IConfiguration)

Declaration
public DocumentAppService(IProjectRepository projectRepository, IDocumentRepository documentRepository, IDocumentSourceFactory documentStoreFactory, IDistributedCache<DocumentResource> resourceCache, IDistributedCache<DocumentUpdateInfo> documentUpdateCache, IHostEnvironment hostEnvironment, IDocumentFullSearch documentFullSearch, IOptions<DocsElasticSearchOptions> docsElasticSearchOptions, IConfiguration configuration)
Parameters
Type Name Description
IProjectRepository projectRepository
IDocumentRepository documentRepository
IDocumentSourceFactory documentStoreFactory
IDistributedCache<DocumentResource> resourceCache
IDistributedCache<DocumentUpdateInfo> documentUpdateCache
IHostEnvironment hostEnvironment
IDocumentFullSearch documentFullSearch
IOptions<DocsElasticSearchOptions> docsElasticSearchOptions
IConfiguration configuration

Properties

DocumentUpdateCache

Declaration
protected IDistributedCache<DocumentUpdateInfo> DocumentUpdateCache { get; }
Property Value
Type Description
IDistributedCache<DocumentUpdateInfo>

HostEnvironment

Declaration
protected IHostEnvironment HostEnvironment { get; }
Property Value
Type Description
IHostEnvironment

NavigationTreePostProcessor

Declaration
public INavigationTreePostProcessor NavigationTreePostProcessor { get; set; }
Property Value
Type Description
INavigationTreePostProcessor

ResourceCache

Declaration
protected IDistributedCache<DocumentResource> ResourceCache { get; }
Property Value
Type Description
IDistributedCache<DocumentResource>

Methods

CreateDocumentWithDetailsDto(Project, Document)

Declaration
protected virtual DocumentWithDetailsDto CreateDocumentWithDetailsDto(Project project, Document document)
Parameters
Type Name Description
Project project
Document document
Returns
Type Description
DocumentWithDetailsDto

FullSearchEnabledAsync()

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

GetAsync(GetDocumentInput)

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

GetDefaultAsync(GetDefaultDocumentInput)

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

GetDocumentWithDetailsDtoAsync(Project, string, string, string)

Declaration
protected virtual Task<DocumentWithDetailsDto> GetDocumentWithDetailsDtoAsync(Project project, string documentName, string languageCode, string version)
Parameters
Type Name Description
Project project
string documentName
string languageCode
string version
Returns
Type Description
Task<DocumentWithDetailsDto>

GetNavigationAsync(GetNavigationDocumentInput)

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

GetParametersAsync(GetParametersDocumentInput)

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

GetResourceAsync(GetDocumentResourceInput)

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

GetUrlsAsync(string)

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

SearchAsync(DocumentSearchInput)

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

Implements

Extension Methods