Interface IHostService

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

    Properties

    | Improve this Doc View Source

    HasMetadataValidation

    Declaration
    bool HasMetadataValidation { get; }
    Property Value
    Type Description
    Boolean
    | Improve this Doc View Source

    Processor

    Get current IDocumentProcessor.

    Declaration
    IDocumentProcessor Processor { get; }
    Property Value
    Type Description
    IDocumentProcessor
    | Improve this Doc View Source

    SourceFiles

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

    Methods

    | Improve this Doc View Source

    GetAllUids()

    Declaration
    ImmutableHashSet<string> GetAllUids()
    Returns
    Type Description
    System.Collections.Immutable.ImmutableHashSet<String>
    | Improve this Doc View Source

    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>
    | Improve this Doc View Source

    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
    | Improve this Doc View Source

    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
    | Improve this Doc View Source

    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
    | Improve this Doc View Source

    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
    | Improve this Doc View Source

    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
    | Improve this Doc View Source

    LookupByUid(String)

    Declaration
    ImmutableList<FileModel> LookupByUid(string uid)
    Parameters
    Type Name Description
    String uid
    Returns
    Type Description
    System.Collections.Immutable.ImmutableList<FileModel>
    | Improve this Doc View Source

    Markup(String, FileAndType)

    Declaration
    MarkupResult Markup(string markdown, FileAndType ft)
    Parameters
    Type Name Description
    String markdown
    FileAndType ft
    Returns
    Type Description
    MarkupResult
    | Improve this Doc View Source

    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
    | Improve this Doc View Source

    MarkupToHtml(String, String)

    Declaration
    [Obsolete]
string MarkupToHtml(string markdown, string file)
    Parameters
    Type Name Description
    String markdown
    String file
    Returns
    Type Description
    String
    | Improve this Doc View Source

    Parse(MarkupResult, FileAndType)

    Declaration
    MarkupResult Parse(MarkupResult markupResult, FileAndType ft)
    Parameters
    Type Name Description
    MarkupResult markupResult
    FileAndType ft
    Returns
    Type Description
    MarkupResult
    | Improve this Doc View Source

    ParseHtml(String, FileAndType)

    Declaration
    [Obsolete]
MarkupResult ParseHtml(string html, FileAndType ft)
    Parameters
    Type Name Description
    String html
    FileAndType ft
    Returns
    Type Description
    MarkupResult
    | Improve this Doc View Source

    ReportDependency(FileModel, ImmutableArray<String>)

    Declaration
    void ReportDependency(FileModel currentFileModel, ImmutableArray<string> dependency)
    Parameters
    Type Name Description
    FileModel currentFileModel
    System.Collections.Immutable.ImmutableArray<String> dependency
    | Improve this Doc View Source

    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