IIssue Interface

Summary

Description of an issue.
Assembly
Cake.Issues.dll
Namespace
Cake.Issues
Implementing Types
graph BT Type["IIssue"] class Type type-node Implementing0["Issue"]-.->Type click Implementing0 "/api/Cake.Issues/Issue"

Syntax

public interface IIssue

Properties

Name Value Summary
AffectedFileRelativePath FilePath
Gets the path to the file affacted 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.
Line Nullable<int>
Gets the line in the file where the issues has occurred. null if the issue affects the whole file or an asssembly.
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.
Rule string
Gets 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.

Extension Methods

Name Value Summary
Dump<IIssue>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
FileDirectory() string
Returns the directory of the AffectedFileRelativePath.
Requires the Cake.Issues addin
FileName() string
Returns the name of the file of the AffectedFileRelativePath.
Requires the Cake.Issues addin
FilePath() string
Returns the full path of the AffectedFileRelativePath.
Requires the Cake.Issues addin
GetExpandoObject(bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, FileLinkSettings, IDictionary<string, Func<IIssue, object>>) ExpandoObject
Returns an dynamic object containing the properties of an issue.
Requires the Cake.Issues.Reporting.Generic addin
IsIn<IIssue>(IIssue[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
Message(IssueCommentFormat) string
Gets the message of the issue in a specific format. If the message is not available in the specific format, the message in text format will be returned.
Requires the Cake.Issues addin
NotNull<IIssue>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<IIssue>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ProjectDirectory() string
Returns the directory of the ProjectFileRelativePath.
Requires the Cake.Issues addin
ProjectPath() string
Returns the full path of ProjectFileRelativePath or null.
Requires the Cake.Issues addin
ThrowIfNull<IIssue>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<IIssue>(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