Interface IDocumentRepository

Inherited Members
Namespace: Volo.Docs.Documents
Assembly: Volo.Docs.Domain.dll
Syntax
public interface IDocumentRepository : IBasicRepository<Document>, IReadOnlyBasicRepository<Document>, IRepository

Methods

DeleteAsync(Guid, string, string, string, bool, CancellationToken)

Declaration
Task DeleteAsync(Guid projectId, string name, string languageCode, string version, bool autoSave = false, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid projectId
string name
string languageCode
string version
bool autoSave
CancellationToken cancellationToken
Returns
Type Description
Task

FindAsync(Guid, List<string>, string, string, bool, CancellationToken)

Declaration
Task<Document> FindAsync(Guid projectId, List<string> possibleNames, string languageCode, string version, bool includeDetails = true, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid projectId
List<string> possibleNames
string languageCode
string version
bool includeDetails
CancellationToken cancellationToken
Returns
Type Description
Task<Document>

FindAsync(Guid, string, string, string, bool, CancellationToken)

Declaration
Task<Document> FindAsync(Guid projectId, string name, string languageCode, string version, bool includeDetails = true, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid projectId
string name
string languageCode
string version
bool includeDetails
CancellationToken cancellationToken
Returns
Type Description
Task<Document>

GetAllAsync(Guid?, string, string, string, string, string, DateTime?, DateTime?, DateTime?, DateTime?, DateTime?, DateTime?, DateTime?, DateTime?, string, int, int, CancellationToken)

Declaration
Task<List<DocumentWithoutContent>> GetAllAsync(Guid? projectId, string name, string version, string languageCode, string fileName, string format, DateTime? creationTimeMin, DateTime? creationTimeMax, DateTime? lastUpdatedTimeMin, DateTime? lastUpdatedTimeMax, DateTime? lastSignificantUpdateTimeMin, DateTime? lastSignificantUpdateTimeMax, DateTime? lastCachedTimeMin, DateTime? lastCachedTimeMax, string sorting = null, int maxResultCount = 2147483647, int skipCount = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid? projectId
string name
string version
string languageCode
string fileName
string format
DateTime? creationTimeMin
DateTime? creationTimeMax
DateTime? lastUpdatedTimeMin
DateTime? lastUpdatedTimeMax
DateTime? lastSignificantUpdateTimeMin
DateTime? lastSignificantUpdateTimeMax
DateTime? lastCachedTimeMin
DateTime? lastCachedTimeMax
string sorting
int maxResultCount
int skipCount
CancellationToken cancellationToken
Returns
Type Description
Task<List<DocumentWithoutContent>>

GetAllCountAsync(Guid?, string, string, string, string, string, DateTime?, DateTime?, DateTime?, DateTime?, DateTime?, DateTime?, DateTime?, DateTime?, string, int, int, CancellationToken)

Declaration
Task<long> GetAllCountAsync(Guid? projectId, string name, string version, string languageCode, string fileName, string format, DateTime? creationTimeMin, DateTime? creationTimeMax, DateTime? lastUpdatedTimeMin, DateTime? lastUpdatedTimeMax, DateTime? lastSignificantUpdateTimeMin, DateTime? lastSignificantUpdateTimeMax, DateTime? lastCachedTimeMin, DateTime? lastCachedTimeMax, string sorting = null, int maxResultCount = 2147483647, int skipCount = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid? projectId
string name
string version
string languageCode
string fileName
string format
DateTime? creationTimeMin
DateTime? creationTimeMax
DateTime? lastUpdatedTimeMin
DateTime? lastUpdatedTimeMax
DateTime? lastSignificantUpdateTimeMin
DateTime? lastSignificantUpdateTimeMax
DateTime? lastCachedTimeMin
DateTime? lastCachedTimeMax
string sorting
int maxResultCount
int skipCount
CancellationToken cancellationToken
Returns
Type Description
Task<long>

GetAsync(Guid, CancellationToken)

Declaration
Task<Document> GetAsync(Guid id, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid id
CancellationToken cancellationToken
Returns
Type Description
Task<Document>

GetListAsync(Guid?, string, string, CancellationToken)

Declaration
Task<List<Document>> GetListAsync(Guid? projectId, string version, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid? projectId
string version
string name
CancellationToken cancellationToken
Returns
Type Description
Task<List<Document>>

GetListByProjectId(Guid, CancellationToken)

Declaration
Task<List<Document>> GetListByProjectId(Guid projectId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid projectId
CancellationToken cancellationToken
Returns
Type Description
Task<List<Document>>

GetListWithoutDetailsByProjectId(Guid, CancellationToken)

Declaration
Task<List<DocumentWithoutDetails>> GetListWithoutDetailsByProjectId(Guid projectId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid projectId
CancellationToken cancellationToken
Returns
Type Description
Task<List<DocumentWithoutDetails>>

GetUniqueDocumentCountByProjectIdAsync(Guid, CancellationToken)

Declaration
Task<long> GetUniqueDocumentCountByProjectIdAsync(Guid projectId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid projectId
CancellationToken cancellationToken
Returns
Type Description
Task<long>

GetUniqueDocumentsByProjectIdPagedAsync(Guid, int, int, CancellationToken)

Declaration
Task<List<Document>> GetUniqueDocumentsByProjectIdPagedAsync(Guid projectId, int skipCount, int maxResultCount, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid projectId
int skipCount
int maxResultCount
CancellationToken cancellationToken
Returns
Type Description
Task<List<Document>>

GetUniqueListDocumentInfoAsync(CancellationToken)

Declaration
Task<List<DocumentInfo>> GetUniqueListDocumentInfoAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<List<DocumentInfo>>

UpdateProjectLastCachedTimeAsync(Guid, DateTime, CancellationToken)

Declaration
Task UpdateProjectLastCachedTimeAsync(Guid projectId, DateTime cachedTime, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid projectId
DateTime cachedTime
CancellationToken cancellationToken
Returns
Type Description
Task

Extension Methods