BasePullRequestSystem Class

Summary

Base class for all pull request system implementations.
Assembly
Cake.Issues.PullRequests.dll
Namespace
Cake.Issues.PullRequests
Interfaces
Base Types
Derived Types
graph BT Type-->Base0["BaseIssueComponent<IReportIssuesToPullRequestSettings>"] Base0-->Base1["Object"] Type-.->Interface0["IPullRequestSystem"] click Interface0 "/api/Cake.Issues.PullRequests/IPullRequestSystem" Type-.->Interface1["IBaseIssueComponent<IReportIssuesToPullRequestSettings>"] Type["BasePullRequestSystem"] class Type type-node Derived0["GitHubActionsPullRequestSystem"]-->Type click Derived0 "/api/Cake.Issues.PullRequests.GitHubActions/GitHubActionsPullRequestSystem" Derived1["AppVeyorPullRequestSystem"]-->Type click Derived1 "/api/Cake.Issues.PullRequests.AppVeyor/AppVeyorPullRequestSystem"

Syntax

public abstract class BasePullRequestSystem : 
    BaseIssueComponent<IReportIssuesToPullRequestSettings>, IPullRequestSystem, 
    IBaseIssueComponent<IReportIssuesToPullRequestSettings>

Constructors

Name Summary
BasePullRequestSystem(ICakeLog) Base class for all pull request system implementations.

Methods

Name Value Summary
AddCapability(IPullRequestSystemCapability) void
Adds a capability.
GetCapability<T>() T
Returns the instance of a specific capability.
HasCapability<T>() bool
Checks if a pull request has a specific capability.
InternalPostDiscussionThreads(IEnumerable<IIssue>, string) void
Posts discussion threads for all issues which need to be posted. Compared to Cake.Issues.PullRequests.BasePullRequestSystem.PostDiscussionThreads(System.Collections.Generic.IEnumerable{Cake.Issues.IIssue},System.String) it is safe to access Settings from this method.
PostDiscussionThreads(IEnumerable<IIssue>, string) void
Posts discussion threads for all issues which need to be posted.

Extension Methods

Name Value Summary
Dump<BasePullRequestSystem>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<BasePullRequestSystem>(BasePullRequestSystem[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<BasePullRequestSystem>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<BasePullRequestSystem>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<BasePullRequestSystem>(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<BasePullRequestSystem>(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