Issue.

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>) Constructor

Summary

Initializes a new instance of the Issue class.
Assembly
Cake.Issues.dll
Namespace
Cake.Issues
Containing Type
Issue

Syntax

public Issue(string identifier, string projectFileRelativePath, string projectName, string affectedFileRelativePath, Nullable<int> line, Nullable<int> endLine, Nullable<int> column, Nullable<int> endColumn, Uri fileLink, string messageText, string messageHtml, string messageMarkdown, Nullable<int> priority, string priorityName, string ruleId, string ruleName, Uri ruleUrl, string run, string providerType, string providerName, IReadOnlyDictionary<string, string> additionalInformation)

Parameters

Name Type Description
identifier string The identifier of the issue. The identifier needs to be identical across multiple runs of an issue provider for the same issue.
projectFileRelativePath string The path to the project to which the file affected by the issue belongs. The path needs to be relative to the repository root. Can be null or System.String.Empty if issue is not related to a project.
projectName string 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.
affectedFileRelativePath string The path to the file affected by the issue. The path needs to be relative to the repository root. null or System.String.Empty if issue is not related to a change in a file.
line Nullable<int> The line in the file where the issues have occurred. null if the issue affects the whole file or an assembly.
endLine Nullable<int> 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.
column Nullable<int> The column in the file where the issues have occurred. null if the issue affects the whole file or an assembly.
endColumn Nullable<int> 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.
fileLink Uri Link to the position in the file where the issue occurred. null if no link is available.
messageText string The message of the issue in plain text format.
messageHtml string The message of the issue in Html format.
messageMarkdown string The message of the issue in Markdown format.
priority Nullable<int> The priority of the message. null if no priority was assigned.
priorityName string The human friendly name of the priority. null or System.String.Empty if no priority was assigned.
ruleId string The ID of the rule of the issue. null or System.String.Empty if issue has no specific rule.
ruleName string The name of the rule of the issue. null or System.String.Empty if issue has no specific rule.
ruleUrl Uri The URL containing information about the failing rule. null if no URL is available.
run string Gets the description of the run.
providerType string The type of the issue provider.
providerName string The human friendly name of the issue provider.
additionalInformation IReadOnlyDictionary<string, string> Custom information regarding the issue.

Return Value

Type Description
void