Class DocumentAppService

Inheritance

System.Object

DocsAppServiceBase

DocumentAppService

Implements

IDocumentAppService

IApplicationService

Namespace: Volo.Docs.Documents

Assembly: Volo.Docs.Application.dll

Syntax

public class DocumentAppService : DocsAppServiceBase, IDocumentAppService, IApplicationService

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 Task<bool> FullSearchEnabledAsync()

Returns

Type	Description
Task<System.Boolean>

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
System.String	documentName
System.String	languageCode
System.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 Task<DocumentParametersDto> GetParametersAsync(GetParametersDocumentInput input)

Parameters

Type	Name	Description
GetParametersDocumentInput	input

Returns

Type	Description
Task<DocumentParametersDto>

GetResourceAsync(GetDocumentResourceInput)

Declaration

public Task<DocumentResourceDto> GetResourceAsync(GetDocumentResourceInput input)

Parameters

Type	Name	Description
GetDocumentResourceInput	input

Returns

Type	Description
Task<DocumentResourceDto>

SearchAsync(DocumentSearchInput)

Declaration

public Task<List<DocumentSearchOutput>> SearchAsync(DocumentSearchInput input)

Parameters

Type	Name	Description
DocumentSearchInput	input

Returns

Type	Description
Task<List<DocumentSearchOutput>>

Implements

IDocumentAppService

IApplicationService

Extension Methods

AbpObjectExtensions.As<T>(Object)

AbpObjectExtensions.To<T>(Object)

AbpObjectExtensions.IsIn<T>(T, T[])

AbpObjectExtensions.If<T>(T, Boolean, Func<T, T>)

AbpObjectExtensions.If<T>(T, Boolean, Action<T>)

LockExtensions.Locking(Object, Action)

LockExtensions.Locking<T>(T, Action<T>)

LockExtensions.Locking<TResult>(Object, Func<TResult>)

LockExtensions.Locking<T, TResult>(T, Func<T, TResult>)