Issue Class

Summary

Base class for an issue.
Assembly
Cake.Issues.dll
Namespace
Cake.Issues
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IIssue"] click Interface0 "/api/Cake.Issues/IIssue" Type["Issue"] class Type type-node

Syntax

public class Issue : IIssue

Constructors

Name Summary
Issue(string, string, string, string, Nullable<int>, Nullable<int>, Nullable<int>, Nullable<int>, Uri, string, string, string, Nullable<int>, string, string, string, Uri, string, string, string, IReadOnlyDictionary<string, string>) Initializes a new instance of the Issue class.

Properties

Name Value Summary
AdditionalInformation IReadOnlyDictionary<string, string>
Gets a dictionary with additional information regarding the issue.
AffectedFileRelativePath FilePath
Gets the path to the file affected by the issue. The path is relative to the repository root. Can be null if issue is not related to a change in a file.
Column Nullable<int>
Gets the column in the file where the issues have occurred. null if the issue affects the whole file or an assembly.
EndColumn Nullable<int>
Gets the end of the column range in the file where the issues have occurred. null if the issue affects the whole file, an assembly or only a single column.
EndLine Nullable<int>
Gets the end of the line range in the file where the issues have occurred. null if the issue affects the whole file, an assembly or only a single line.
FileLink Uri
Gets or sets a link to the position in the file where the issue occurred. null if FileLinkSettings was not set while reading issue.
Identifier string
Gets the identifier for the message. The identifier can be used to identify the same issue across multiple runs.
Line Nullable<int>
Gets the line in the file where the issues have occurred. null if the issue affects the whole file or an assembly.
MessageHtml string
Gets the message of the issue in HTML format.
MessageMarkdown string
Gets the message of the issue in Markdown format.
MessageText string
Gets the message of the issue in text format.
Priority Nullable<int>
Gets the priority of the message. A higher value indicates a higher priority. null if no priority was assigned.
PriorityName string
Gets the human friendly name of the priority. null or System.String.Empty if no priority was assigned.
ProjectFileRelativePath FilePath
Gets the path to the project to which the file affected by the issue belongs. The path is relative to the repository root. Can be null if issue is not related to a project.
ProjectName string
Gets the name of the project to which the file affected by the issue belongs. Can be null or System.String.Empty if issue is not related to a project.
ProviderName string
Gets the human friendly name of the issue provider.
ProviderType string
Gets the type of the issue provider.
RuleId string
Gets the id of the rule of the issue. Can be null or System.String.Empty if the issue provider provides no rule.
RuleName string
Gets the name of the rule of the issue. Can be null or System.String.Empty if the issue provider provides no rule.
RuleUrl Uri
Gets the URL containing information about the failing rule. Can be null if the issue provider provides no URL.
Run string
Gets or sets the description of the run. Can be null or System.String.Empty if no run information is provided.

Extension Methods

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