IIssueReportFormat Interface

Summary

Interface describing an issue report format.
graph BT Type-.->Interface0["IBaseIssueComponent<ICreateIssueReportSettings>"] Type["IIssueReportFormat"] class Type type-node Implementing0["IssueReportFormat"]-.->Type click Implementing0 "/api/Cake.Issues.Reporting/IssueReportFormat"

Syntax

public interface IIssueReportFormat : IBaseIssueComponent<ICreateIssueReportSettings>

Methods

Name Value Summary
CreateReport(IEnumerable<IIssue>) FilePath
Creates a report from a list of issues.

Extension Methods

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