IBaseIssueComponent<T> Interface

Summary

Interface describing a Cake.Issues component.
graph BT Type["IBaseIssueComponent<T>"] class Type type-node Implementing0["GitHubActionsPullRequestSystem"]-.->Type click Implementing0 "/api/Cake.Issues.PullRequests.GitHubActions/GitHubActionsPullRequestSystem" Implementing1["BasePullRequestSystem"]-.->Type click Implementing1 "/api/Cake.Issues.PullRequests/BasePullRequestSystem" Implementing2["IPullRequestSystem"]-.->Type click Implementing2 "/api/Cake.Issues.PullRequests/IPullRequestSystem" Implementing3["BaseConfigurableIssueProvider<T>"]-.->Type click Implementing3 "/api/Cake.Issues/BaseConfigurableIssueProvider_1" Implementing4["MarkdownlintIssuesProvider"]-.->Type click Implementing4 "/api/Cake.Issues.Markdownlint/MarkdownlintIssuesProvider" Implementing5["BaseIssueComponent<T>"]-.->Type click Implementing5 "/api/Cake.Issues/BaseIssueComponent_1" Implementing6["AppVeyorPullRequestSystem"]-.->Type click Implementing6 "/api/Cake.Issues.PullRequests.AppVeyor/AppVeyorPullRequestSystem" Implementing7["BaseMultiFormatIssueProvider<TSettings, TIssueProvider>"]-.->Type click Implementing7 "/api/Cake.Issues/BaseMultiFormatIssueProvider_2" Implementing8["EsLintIssuesProvider"]-.->Type click Implementing8 "/api/Cake.Issues.EsLint/EsLintIssuesProvider" Implementing9["BaseIssueProvider"]-.->Type click Implementing9 "/api/Cake.Issues/BaseIssueProvider" Implementing10["MsBuildIssuesProvider"]-.->Type click Implementing10 "/api/Cake.Issues.MsBuild/MsBuildIssuesProvider" Implementing11["IssueReportFormat"]-.->Type click Implementing11 "/api/Cake.Issues.Reporting/IssueReportFormat" Implementing12["IIssueReportFormat"]-.->Type click Implementing12 "/api/Cake.Issues.Reporting/IIssueReportFormat" Implementing13["IIssueProvider"]-.->Type click Implementing13 "/api/Cake.Issues/IIssueProvider"

Syntax

public interface IBaseIssueComponent<in T> where T : IRepositorySettings

Type Parameters

Name Description
T Type of settings.

Methods

Name Value Summary
AssertInitialized() void
Asserts that Initialize(T) was called.
Initialize(T) bool
Initializes the component.

Extension Methods

Name Value Summary
Dump<IBaseIssueComponent<T>>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<IBaseIssueComponent<T>>(IBaseIssueComponent<T>[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<IBaseIssueComponent<T>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<IBaseIssueComponent<T>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<IBaseIssueComponent<T>>(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
ThrowIfNull<IBaseIssueComponent<T>>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin