Interface IHostService

    Namespace:Microsoft.DocAsCode.Plugins
    Assembly:Microsoft.DocAsCode.Plugins.dll
    Syntax
    public interface IHostService

    Properties

    HasMetadataValidation

    Declaration
    bool HasMetadataValidation { get; }
    Property Value
    Type Description
    Boolean

    IncrementalInfos

    Declaration
    ImmutableDictionary<string, FileIncrementalInfo> IncrementalInfos { get; }
    Property Value
    Type Description
    System.Collections.Immutable.ImmutableDictionary<String, FileIncrementalInfo>

    Processor

    Get current IDocumentProcessor.

    Declaration
    IDocumentProcessor Processor { get; }
    Property Value
    Type Description
    IDocumentProcessor

    SourceFiles

    Declaration
    ImmutableDictionary<string, FileAndType> SourceFiles { get; }
    Property Value
    Type Description
    System.Collections.Immutable.ImmutableDictionary<String, FileAndType>

    TableOfContentRestructions

    Declaration
    ImmutableList<TreeItemRestructure> TableOfContentRestructions { get; set; }
    Property Value
    Type Description
    System.Collections.Immutable.ImmutableList<TreeItemRestructure>

    VersionName

    current version's name, String.Empty for default version

    Declaration
    string VersionName { get; }
    Property Value
    Type Description
    String

    VersionOutputFolder

    current version's output base folder

    Declaration
    string VersionOutputFolder { get; }
    Property Value
    Type Description
    String

    Methods

    GetAllUids()

    Declaration
    ImmutableHashSet<string> GetAllUids()
    Returns
    Type Description
    System.Collections.Immutable.ImmutableHashSet<String>

    GetModels(Nullable<DocumentType>)

    Declaration
    ImmutableList<FileModel> GetModels(DocumentType? type = null)
    Parameters
    Type Name Description
    Nullable<DocumentType> type
    Returns
    Type Description
    System.Collections.Immutable.ImmutableList<FileModel>

    LogDiagnostic(String, String, String)

    Declaration
    void LogDiagnostic(string message, string file = null, string line = null)
    Parameters
    Type Name Description
    String message
    String file
    String line

    LogError(String, String, String)

    Declaration
    void LogError(string message, string file = null, string line = null)
    Parameters
    Type Name Description
    String message
    String file
    String line

    LogInfo(String, String, String)

    Declaration
    void LogInfo(string message, string file = null, string line = null)
    Parameters
    Type Name Description
    String message
    String file
    String line

    LogVerbose(String, String, String)

    Declaration
    void LogVerbose(string message, string file = null, string line = null)
    Parameters
    Type Name Description
    String message
    String file
    String line

    LogWarning(String, String, String)

    Declaration
    void LogWarning(string message, string file = null, string line = null)
    Parameters
    Type Name Description
    String message
    String file
    String line

    LookupByUid(String)

    Declaration
    ImmutableList<FileModel> LookupByUid(string uid)
    Parameters
    Type Name Description
    String uid
    Returns
    Type Description
    System.Collections.Immutable.ImmutableList<FileModel>

    Markup(String, FileAndType)

    Declaration
    MarkupResult Markup(string markdown, FileAndType ft)
    Parameters
    Type Name Description
    String markdown
    FileAndType ft
    Returns
    Type Description
    MarkupResult

    Markup(String, FileAndType, Boolean)

    Declaration
    MarkupResult Markup(string markdown, FileAndType ft, bool omitParse)
    Parameters
    Type Name Description
    String markdown
    FileAndType ft
    Boolean omitParse
    Returns
    Type Description
    MarkupResult

    Parse(MarkupResult, FileAndType)

    Declaration
    MarkupResult Parse(MarkupResult markupResult, FileAndType ft)
    Parameters
    Type Name Description
    MarkupResult markupResult
    FileAndType ft
    Returns
    Type Description
    MarkupResult

    ReportDependencyFrom(FileModel, String, String)

    report dependency from

    Declaration
    void ReportDependencyFrom(FileModel currentFileModel, string from, string type)
    Parameters
    Type Name Description
    FileModel currentFileModel

    filemodel of 'to' node
    String from

    'from' node's file path from working directory or file path relative to 'to' filemodel
    String type

    dependency type

    ReportDependencyFrom(FileModel, String, String, String)

    report dependency from

    Declaration
    void ReportDependencyFrom(FileModel currentFileModel, string from, string fromType, string type)
    Parameters
    Type Name Description
    FileModel currentFileModel

    filemodel of 'to' node
    String from

    'from' node's value
    String fromType

    'from' node's type, it could be file or reference type
    String type

    dependency type

    ReportDependencyTo(FileModel, String, String)

    report dependency to

    Declaration
    void ReportDependencyTo(FileModel currentFileModel, string to, string type)
    Parameters
    Type Name Description
    FileModel currentFileModel

    filemodel of 'from' node
    String to

    'to' node's file path from working directory or file path relative to 'from' filemodel
    String type

    dependency type

    ReportDependencyTo(FileModel, String, String, String)

    report dependency to

    Declaration
    void ReportDependencyTo(FileModel currentFileModel, string to, string toType, string type)
    Parameters
    Type Name Description
    FileModel currentFileModel

    filemodel of 'from' node
    String to

    'to' node's value
    String toType

    'to' node's type, it could be file or reference type
    String type

    dependency type

    ReportReference(FileModel, String, String)

    report reference

    Declaration
    void ReportReference(FileModel currentFileModel, string reference, string referenceType)
    Parameters
    Type Name Description
    FileModel currentFileModel

    filemodel
    String reference

    the reference that the 'filemodel' could provide
    String referenceType

    the type of the reference

    ValidateInputMetadata(String, ImmutableDictionary<String, Object>)

    Declaration
    void ValidateInputMetadata(string file, ImmutableDictionary<string, object> metadata)
    Parameters
    Type Name Description
    String file
    System.Collections.Immutable.ImmutableDictionary<String, Object> metadata

    Extension Methods