Class GithubDocumentSource

Inheritance
System.Object
DomainService
GithubDocumentSource
Implements
ITransientDependency
Inherited Members
Namespace: Volo.Docs.GitHub.Documents
Assembly: Volo.Docs.Domain.dll
Syntax
public class GithubDocumentSource : DomainService, IDocumentSource, IDomainService, ITransientDependency

Constructors

GithubDocumentSource(IGithubRepositoryManager, IGithubPatchAnalyzer, IVersionHelper)

Declaration
public GithubDocumentSource(IGithubRepositoryManager githubRepositoryManager, IGithubPatchAnalyzer githubPatchAnalyzer, IVersionHelper versionHelper)
Parameters
Type Name Description
IGithubRepositoryManager githubRepositoryManager
IGithubPatchAnalyzer githubPatchAnalyzer
IVersionHelper versionHelper

Fields

Type

Declaration
public const string Type = null
Field Value
Type Description
System.String

Methods

GetDocumentAsync(Project, String, String, String, Nullable<DateTime>)

Declaration
public virtual Task<Document> GetDocumentAsync(Project project, string documentName, string languageCode, string version, DateTime? lastKnownSignificantUpdateTime = null)
Parameters
Type Name Description
Project project
System.String documentName
System.String languageCode
System.String version
System.Nullable<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
System.String version
Returns
Type Description
Task<LanguageConfig>

GetOwnerNameFromUrl(String)

Declaration
protected virtual string GetOwnerNameFromUrl(string url)
Parameters
Type Name Description
System.String url
Returns
Type Description
System.String

GetRepositoryNameFromUrl(String)

Declaration
protected virtual string GetRepositoryNameFromUrl(string url)
Parameters
Type Name Description
System.String url
Returns
Type Description
System.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
System.String resourceName
System.String languageCode
System.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

ITransientDependency

Extension Methods