Class Document

Inheritance
object
Entity
Entity<Guid>
BasicAggregateRoot<Guid>
AggregateRoot<Guid>
Document
Implements
Inherited Members
Namespace: Volo.Docs.Documents
Assembly: Volo.Docs.Domain.dll
Syntax
public class Document : AggregateRoot<Guid>, IAggregateRoot<Guid>, IEntity<Guid>, IAggregateRoot, IEntity, IGeneratesDomainEvents, IHasExtraProperties, IHasConcurrencyStamp

Constructors

Document()

Declaration
protected Document()

Document(Guid, Guid, string, string, string, string, string, string, string, string, string, string, DateTime, DateTime, DateTime, DateTime?)

Declaration
public Document(Guid id, Guid projectId, string name, string version, string languageCode, string fileName, string content, string format, string editLink, string rootUrl, string rawRootUrl, string localDirectory, DateTime creationTime, DateTime lastUpdatedTime, DateTime lastCachedTime, DateTime? lastSignificantUpdateTime = null)
Parameters
Type Name Description
Guid id
Guid projectId
string name
string version
string languageCode
string fileName
string content
string format
string editLink
string rootUrl
string rawRootUrl
string localDirectory
DateTime creationTime
DateTime lastUpdatedTime
DateTime lastCachedTime
DateTime? lastSignificantUpdateTime

Properties

Content

Declaration
public virtual string Content { get; set; }
Property Value
Type Description
string

Contributors

Declaration
public virtual List<DocumentContributor> Contributors { get; set; }
Property Value
Type Description
List<DocumentContributor>

CreationTime

Declaration
public virtual DateTime CreationTime { get; set; }
Property Value
Type Description
DateTime
Declaration
public virtual string EditLink { get; set; }
Property Value
Type Description
string

FileName

Declaration
public virtual string FileName { get; set; }
Property Value
Type Description
string

Format

Declaration
public virtual string Format { get; set; }
Property Value
Type Description
string

LanguageCode

Declaration
public virtual string LanguageCode { get; protected set; }
Property Value
Type Description
string

LastCachedTime

Declaration
public virtual DateTime LastCachedTime { get; set; }
Property Value
Type Description
DateTime

LastSignificantUpdateTime

Declaration
public virtual DateTime? LastSignificantUpdateTime { get; set; }
Property Value
Type Description
DateTime?

LastUpdatedTime

Declaration
public virtual DateTime LastUpdatedTime { get; set; }
Property Value
Type Description
DateTime

LocalDirectory

Declaration
public virtual string LocalDirectory { get; set; }
Property Value
Type Description
string

Name

Declaration
public virtual string Name { get; protected set; }
Property Value
Type Description
string

ProjectId

Declaration
public virtual Guid ProjectId { get; protected set; }
Property Value
Type Description
Guid

RawRootUrl

Declaration
public virtual string RawRootUrl { get; set; }
Property Value
Type Description
string

RootUrl

Declaration
public virtual string RootUrl { get; set; }
Property Value
Type Description
string

Version

Declaration
public virtual string Version { get; protected set; }
Property Value
Type Description
string

Methods

AddContributor(string, string, string, int)

Declaration
public virtual void AddContributor(string username, string userProfileUrl, string avatarUrl, int commitCount = 1)
Parameters
Type Name Description
string username
string userProfileUrl
string avatarUrl
int commitCount

FindContributor(string, string, string)

Declaration
public virtual DocumentContributor FindContributor(string username, string userProfileUrl, string avatarUrl)
Parameters
Type Name Description
string username
string userProfileUrl
string avatarUrl
Returns
Type Description
DocumentContributor

RemoveAllContributors()

Declaration
public virtual void RemoveAllContributors()

RemoveContributor(string, string, string)

Declaration
public virtual void RemoveContributor(string username, string userProfileUrl, string avatarUrl)
Parameters
Type Name Description
string username
string userProfileUrl
string avatarUrl

Implements

Extension Methods