IIssueProvider Interface

Summary

Interface describing a provider for issues.
graph BT Type-.->Interface0["IBaseIssueComponent<IReadIssuesSettings>"] Type["IIssueProvider"] class Type type-node Implementing0["BaseMultiFormatIssueProvider<TSettings, TIssueProvider>"]-.->Type click Implementing0 "/api/Cake.Issues/BaseMultiFormatIssueProvider_2" Implementing1["MarkdownlintIssuesProvider"]-.->Type click Implementing1 "/api/Cake.Issues.Markdownlint/MarkdownlintIssuesProvider" Implementing2["BaseConfigurableIssueProvider<T>"]-.->Type click Implementing2 "/api/Cake.Issues/BaseConfigurableIssueProvider_1" Implementing3["MsBuildIssuesProvider"]-.->Type click Implementing3 "/api/Cake.Issues.MsBuild/MsBuildIssuesProvider" Implementing4["EsLintIssuesProvider"]-.->Type click Implementing4 "/api/Cake.Issues.EsLint/EsLintIssuesProvider" Implementing5["BaseIssueProvider"]-.->Type click Implementing5 "/api/Cake.Issues/BaseIssueProvider"

Syntax

public interface IIssueProvider : IBaseIssueComponent<IReadIssuesSettings>

Properties

Name Value Summary
ProviderName string
Gets the human friendly name of the issue provider.

Methods

Name Value Summary
ReadIssues() IEnumerable<IIssue>
Gets all issues.

Extension Methods

Name Value Summary
Dump<IIssueProvider>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<IIssueProvider>(IIssueProvider[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<IIssueProvider>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<IIssueProvider>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<IIssueProvider>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<IIssueProvider>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin