Class GithubDocumentSource

Inheritance

object

DomainService

GithubDocumentSource

Implements

IDocumentSource

IDomainService

ITransientDependency

Inherited Members

DomainService.LazyServiceProvider

DomainService.ServiceProvider

DomainService.Clock

DomainService.GuidGenerator

DomainService.LoggerFactory

DomainService.CurrentTenant

DomainService.AsyncExecuter

DomainService.Logger

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Volo.Docs.GitHub.Documents

Assembly: Volo.Docs.Domain.dll

Syntax

public class GithubDocumentSource : DomainService, IDocumentSource, IDomainService, ITransientDependency

Constructors

GithubDocumentSource(IGithubRepositoryManager, IGithubPatchAnalyzer, IDocumentRepository, IOptions<DocsGithubLanguageOptions>)

Declaration

public GithubDocumentSource(IGithubRepositoryManager githubRepositoryManager, IGithubPatchAnalyzer githubPatchAnalyzer, IDocumentRepository documentRepository, IOptions<DocsGithubLanguageOptions> docsGithubLanguageOptions)

Parameters

Type	Name	Description
IGithubRepositoryManager	githubRepositoryManager
IGithubPatchAnalyzer	githubPatchAnalyzer
IDocumentRepository	documentRepository
IOptions<DocsGithubLanguageOptions>	docsGithubLanguageOptions

Fields

Type

Declaration

public const string Type = "GitHub"

Field Value

Type	Description
string

Methods

GetDocumentAsync(Project, string, string, string, DateTime?)

Declaration

public virtual Task<Document> GetDocumentAsync(Project project, string documentName, string languageCode, string version, DateTime? lastKnownSignificantUpdateTime = null)

Parameters

Type	Name	Description
Project	project
string	documentName
string	languageCode
string	version
DateTime?	lastKnownSignificantUpdateTime

Returns

Type	Description
Task<Document>

GetLanguageListAsync(Project, string)

Declaration

public Task<LanguageConfig> GetLanguageListAsync(Project project, string version)

Parameters

Type	Name	Description
Project	project
string	version

Returns

Type	Description
Task<LanguageConfig>

GetOwnerNameFromUrl(string)

Declaration

protected virtual string GetOwnerNameFromUrl(string url)

Parameters

Type	Name	Description
string	url

Returns

Type	Description
string

GetRepositoryNameFromUrl(string)

Declaration

protected virtual string GetRepositoryNameFromUrl(string url)

Parameters

Type	Name	Description
string	url

Returns

Type	Description
string

GetResource(Project, string, string, string)

Declaration

public Task<DocumentResource> GetResource(Project project, string resourceName, string languageCode, string version)

Parameters

Type	Name	Description
Project	project
string	resourceName
string	languageCode
string	version

Returns

Type	Description
Task<DocumentResource>

GetVersionsAsync(Project)

Declaration

public Task<List<VersionInfo>> GetVersionsAsync(Project project)

Parameters

Type	Name	Description
Project	project

Returns

Type	Description
Task<List<VersionInfo>>

Implements

IDocumentSource

IDomainService

ITransientDependency

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>)