ReadIssuesSettings Class

Summary

Settings for reading issues.
graph BT Type-->Base0["RepositorySettings"] click Base0 "/api/Cake.Issues/RepositorySettings" Base0-->Base1["Object"] Type-.->Interface0["IReadIssuesSettings"] click Interface0 "/api/Cake.Issues/IReadIssuesSettings" Type-.->Interface1["IRepositorySettings"] click Interface1 "/api/Cake.Issues/IRepositorySettings" Type["ReadIssuesSettings"] class Type type-node Derived0["ReportIssuesToPullRequestFromIssueProviderSettings"]-->Type click Derived0 "/api/Cake.Issues.PullRequests/ReportIssuesToPullRequestFromIssueProviderSettings" Derived1["CreateIssueReportFromIssueProviderSettings"]-->Type click Derived1 "/api/Cake.Issues.Reporting/CreateIssueReportFromIssueProviderSettings"

Syntax

public class ReadIssuesSettings : RepositorySettings, IReadIssuesSettings, IRepositorySettings

Constructors

Name Summary
ReadIssuesSettings(DirectoryPath) Settings for reading issues.

Properties

Name Value Summary
FileLinkSettings FileLinkSettings
Gets or sets settings which can be used for resolving links to source files.
RepositoryRoot DirectoryPath
Gets the Root path of the repository.
Inherited from RepositorySettings
Run string
Gets or sets the name of the run.

Extension Methods

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