Class Project

Inheritance

object

Entity

Entity<Guid>

BasicAggregateRoot<Guid>

AggregateRoot<Guid>

Project

Implements

IAggregateRoot<Guid>

IEntity<Guid>

IAggregateRoot

IEntity

IGeneratesDomainEvents

IHasExtraProperties

IHasConcurrencyStamp

Inherited Members

AggregateRoot<Guid>.Validate(ValidationContext)

AggregateRoot<Guid>.ExtraProperties

AggregateRoot<Guid>.ConcurrencyStamp

BasicAggregateRoot<Guid>.GetLocalEvents()

BasicAggregateRoot<Guid>.GetDistributedEvents()

BasicAggregateRoot<Guid>.ClearLocalEvents()

BasicAggregateRoot<Guid>.ClearDistributedEvents()

BasicAggregateRoot<Guid>.AddLocalEvent(object)

BasicAggregateRoot<Guid>.AddDistributedEvent(object)

Entity<Guid>.GetKeys()

Entity<Guid>.ToString()

Entity<Guid>.Id

Entity.EntityEquals(IEntity)

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Volo.Docs.Projects

Assembly: Volo.Docs.Domain.dll

Syntax

public class Project : AggregateRoot<Guid>, IAggregateRoot<Guid>, IEntity<Guid>, IAggregateRoot, IEntity, IGeneratesDomainEvents, IHasExtraProperties, IHasConcurrencyStamp

Constructors

Project()

Declaration

protected Project()

Project(Guid, string, string, string, string, string, string, string)

Declaration

public Project(Guid id, string name, string shortName, string documentStoreType, string format, string defaultDocumentName = "Index", string navigationDocumentName = "docs-nav.json", string parametersDocumentName = "docs-params.json")

Parameters

Type	Name	Description
Guid	id
string	name
string	shortName
string	documentStoreType
string	format
string	defaultDocumentName
string	navigationDocumentName
string	parametersDocumentName

Properties

DefaultDocumentName

Declaration

public virtual string DefaultDocumentName { get; protected set; }

Property Value

Type	Description
string

DocumentStoreType

Declaration

public virtual string DocumentStoreType { get; protected set; }

Property Value

Type	Description
string

Format

Declaration

public virtual string Format { get; protected set; }

Property Value

Type	Description
string

LatestVersionBranchName

Declaration

public virtual string LatestVersionBranchName { get; set; }

Property Value

Type	Description
string

MainWebsiteUrl

Declaration

public virtual string MainWebsiteUrl { get; set; }

Property Value

Type	Description
string

MinimumVersion

Declaration

public virtual string MinimumVersion { get; set; }

Property Value

Type	Description
string

Name

Declaration

public virtual string Name { get; protected set; }

Property Value

Type	Description
string

NavigationDocumentName

Declaration

public virtual string NavigationDocumentName { get; protected set; }

Property Value

Type	Description
string

ParametersDocumentName

Declaration

public virtual string ParametersDocumentName { get; protected set; }

Property Value

Type	Description
string

PdfFiles

Declaration

public virtual List<ProjectPdfFile> PdfFiles { get; set; }

Property Value

Type	Description
List<ProjectPdfFile>

ShortName

Declaration

public virtual string ShortName { get; protected set; }

Property Value

Type	Description
string

Methods

AddPdfFile(Guid, string, string, string)

Declaration

public virtual void AddPdfFile(Guid projectId, string fileName, string version, string languageCode)

Parameters

Type	Name	Description
Guid	projectId
string	fileName
string	version
string	languageCode

FindPdfFile(string)

Declaration

public virtual ProjectPdfFile FindPdfFile(string fileName)

Parameters

Type	Name	Description
string	fileName

Returns

Type	Description
ProjectPdfFile

GetFullVersion(string)

Declaration

public virtual string GetFullVersion(string version)

Parameters

Type	Name	Description
string	version

Returns

Type	Description
string

GetGithubVersionProviderSource(Project)

Declaration

protected virtual GithubVersionProviderSource GetGithubVersionProviderSource(Project project)

Parameters

Type	Name	Description
Project	project

Returns

Type	Description
GithubVersionProviderSource

GetProjectVersionPrefixIfExist(Project)

Declaration

protected virtual string GetProjectVersionPrefixIfExist(Project project)

Parameters

Type	Name	Description
Project	project

Returns

Type	Description
string

RemovePdfFile(string)

Declaration

public virtual void RemovePdfFile(string fileName)

Parameters

Type	Name	Description
string	fileName

SetDefaultDocumentName(string)

Declaration

public void SetDefaultDocumentName(string defaultDocumentName)

Parameters

Type	Name	Description
string	defaultDocumentName

SetFormat(string)

Declaration

public void SetFormat(string format)

Parameters

Type	Name	Description
string	format

SetName(string)

Declaration

public void SetName(string name)

Parameters

Type	Name	Description
string	name

SetNavigationDocumentName(string)

Declaration

public void SetNavigationDocumentName(string navigationDocumentName)

Parameters

Type	Name	Description
string	navigationDocumentName

SetParametersDocumentName(string)

Declaration

public void SetParametersDocumentName(string parametersDocumentName)

Parameters

Type	Name	Description
string	parametersDocumentName

Implements

IAggregateRoot<TKey>

IEntity<TKey>

IAggregateRoot

IEntity

IGeneratesDomainEvents

IHasExtraProperties

IHasConcurrencyStamp

Extension Methods

AbpObjectExtensions.As<T>(object)

AbpObjectExtensions.To<T>(object)

LockExtensions.Locking(object, Action)

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

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

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

AbpObjectExtensions.IsIn<T>(T, IEnumerable<T>)

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

AbpQueryableExtensions.OrderByIf<T, TQueryable>(TQueryable, bool, string)

AbpQueryableExtensions.PageBy<T, TQueryable>(TQueryable, int, int)

AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, bool>>)

AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, int, bool>>)

AbpOpenIddictQueryableExtensions.SkipIf<T, TQueryable>(TQueryable, bool, int?)

AbpOpenIddictQueryableExtensions.TakeIf<T, TQueryable>(TQueryable, bool, int?)

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

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

ProjectFileSystemExtensions.GetFileSystemPath(Project)

ProjectFileSystemExtensions.SetFileSystemPath(Project, string)

ProjectGithubExtensions.GetGitHubAccessTokenOrNull(Project)

ProjectGithubExtensions.GetGitHubInnerUrl(Project, string, string)

ProjectGithubExtensions.GetGitHubUrl(Project)

ProjectGithubExtensions.GetGitHubUrl(Project, string)

ProjectGithubExtensions.GetGithubUserAgentOrNull(Project)

ProjectGithubExtensions.SetGitHubAccessToken(Project, string)

ProjectGithubExtensions.SetGitHubUrl(Project, string)