This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.Issues.Reporting.
Summary
Base class for all report format implementations.
- Assembly
- Cake
.Issues .Reporting .dll - Namespace
- Cake
.Issues .Reporting - Interfaces
- Base Types
graph BT
Type-->Base0["BaseIssueComponent<ICreateIssueReportSettings>"]
Base0-->Base1["Object"]
Type-.->Interface0["IIssueReportFormat"]
click Interface0 "/api/Cake.Issues.Reporting/IIssueReportFormat"
Type-.->Interface1["IBaseIssueComponent<ICreateIssueReportSettings>"]
Type["IssueReportFormat"]
class Type type-node
Syntax
public abstract class IssueReportFormat : BaseIssueComponent<ICreateIssueReportSettings>,
IIssueReportFormat, IBaseIssueComponent<ICreateIssueReportSettings>Constructors
| Name | Summary |
|---|---|
| IssueReportFormat |
Base class for all report format implementations. |
Methods
| Name | Value | Summary |
|---|---|---|
| CreateReport |
FilePath |
Creates a report from a list of issues.
|
| InternalCreateReport |
FilePath |
Creates a report from a list of issues.
Compared to
Cake.Issues.Reporting.IssueReportFormat.CreateReport(System.Collections.Generic.IEnumerable{Cake.Issues.IIssue}) it is safe to access Settings from this method.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|