GenericIssueReportFormatSettings Class

Summary

Settings for GenericIssueReportFormatAliases.
Assembly
Cake.Issues.Reporting.Generic.dll
Namespace
Cake.Issues.Reporting.Generic
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["GenericIssueReportFormatSettings"] class Type type-node

Syntax

public class GenericIssueReportFormatSettings

Constructors

Name Summary
GenericIssueReportFormatSettings(FilePath) Initializes a new instance of the GenericIssueReportFormatSettings class.
GenericIssueReportFormatSettings(GenericIssueReportTemplate) Initializes a new instance of the GenericIssueReportFormatSettings class.
GenericIssueReportFormatSettings(string) Initializes a new instance of the GenericIssueReportFormatSettings class.

Properties

Name Value Summary
Options Dictionary<string, object>
Gets the options to use for generating the report. See template for available options.
Template string
Gets the template to use for generating the report.

Methods

Name Value Summary
FromContent(string) GenericIssueReportFormatSettings
Returns a new instance of the GenericIssueReportFormatSettings class from the content of a template file.
static
FromEmbeddedTemplate(GenericIssueReportTemplate) GenericIssueReportFormatSettings
Returns a new instance of the GenericIssueReportFormatSettings class from a template file on disk.
static
FromFilePath(FilePath) GenericIssueReportFormatSettings
Returns a new instance of the GenericIssueReportFormatSettings class from a template file on disk.
static

Extension Methods

Name Value Summary
Dump<GenericIssueReportFormatSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<GenericIssueReportFormatSettings>(GenericIssueReportFormatSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<GenericIssueReportFormatSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<GenericIssueReportFormatSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<GenericIssueReportFormatSettings>(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<GenericIssueReportFormatSettings>(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
WithOption(Enum, object) GenericIssueReportFormatSettings
Adds an option which should be passed to the template.
Requires the Cake.Issues.Reporting.Generic addin
WithOption(string, object) GenericIssueReportFormatSettings
Adds an option which should be passed to the template.
Requires the Cake.Issues.Reporting.Generic addin