Summary
Checks values of an issue.
Syntax
public static void Check(IIssue issue, string providerType, string providerName, string run, 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, IReadOnlyDictionary<string, string> additionalInformation)
Attributes
Parameters
Name |
Type |
Description |
issue |
IIssue |
Issue which should be checked. |
providerType |
string |
Expected type of the issue provider. |
providerName |
string |
Expected human friendly name of the issue provider. |
run |
string |
Expected name of the run which reported the issue. |
identifier |
string |
Expected identifier of the issue. |
projectFileRelativePath |
string |
Expected relative path of the project file.
null if the issue is not expected to be related to a project. |
projectName |
string |
Expected project name.
null or System.String.Empty if the issue is not expected to be related to a project. |
affectedFileRelativePath |
string |
Expected relative path of the affected file.
null if the issue is not expected to be related to a change in a file. |
line |
Nullable<int> |
Expected line number.
null if the issue is not expected to be related to a file or specific line. |
endLine |
Nullable<int> |
Expected end of line range.
null if the issue is not expected to be related to a file, specific line or range of lines. |
column |
Nullable<int> |
Expected column.
null if the issue is not expected to be related to a file or specific column. |
endColumn |
Nullable<int> |
Expected end of column range.
null if the issue is not expected to be related to a file, specific column or range of columns. |
fileLink |
Uri |
Expected file link.
null if the issue is not expected to have a file link. |
messageText |
string |
Expected message in plain text format. |
messageHtml |
string |
Expected message in HTML format. |
messageMarkdown |
string |
Expected message in Markdown format. |
priority |
Nullable<int> |
Expected priority.
null if no priority is expected. |
priorityName |
string |
Expected priority name.
null or System.String.Empty if no priority is expected. |
ruleId |
string |
Expected rule identifier.
null or System.String.Empty if no rule identifier is expected. |
ruleName |
string |
Expected name of the rule.
null or System.String.Empty if no rule is expected. |
ruleUrl |
Uri |
Expected URL containing information about the failing rule.
null if no rule Url is expected. |
additionalInformation |
IReadOnlyDictionary<string, string> |
Custom information regarding the issue. |
Return Value