IdeIntegrationSettings Class

This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Issues.Reporting.Generic.

Summary

Settings how issues should be integrated to IDEs.

Assembly

Cake.Issues.Reporting.Generic.dll

Namespace

Cake.Issues.Reporting.Generic

Base Types

Object

graph BT Type-->Base0["Object"] Type["IdeIntegrationSettings"] class Type type-node

Syntax

public class IdeIntegrationSettings

Constructors

Name	Summary
IdeIntegrationSettings()

Properties

Name	Value	Summary
JavaScript	string	Gets or sets additional JavaScript which should be added.
MenuEntryText	string	Gets or sets text which should be shown in the dropdown menu for opening the file affected by an issue in an IDE. Default value is `Open in IDE`.
OpenInIdeCall	string	Gets or sets JavaScript which should be called to open the file affected by an issue in an IDE.

Methods

Name	Value	Summary
GetOpenInIdeCall(string, string, string, string, string)	string	Returns the JavaScript which should be called to open the file affected by an issue in an IDE with all patterns of `OpenInIdeCall` replaced.

Extension Methods

Name	Value	Summary
Dump<IdeIntegrationSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<IdeIntegrationSettings>(IdeIntegrationSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<IdeIntegrationSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<IdeIntegrationSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<IdeIntegrationSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<IdeIntegrationSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin