FileLinkOptionalSettingsBuilder Class

Summary

Class containing builder for optional settings for linking to files.
Assembly
Cake.Issues.dll
Namespace
Cake.Issues.FileLinking
Base Types
graph BT Type-->Base0["FileLinkSettings"] click Base0 "/api/Cake.Issues/FileLinkSettings" Base0-->Base1["Object"] Type["FileLinkOptionalSettingsBuilder"] class Type type-node

Syntax

public class FileLinkOptionalSettingsBuilder : FileLinkSettings

Methods

Name Value Summary
ForAction(Func<IIssue, Uri>) FileLinkSettings
Returns settings to link files based on a custom pattern.
Inherited from FileLinkSettings
static
ForAzureDevOps(Uri) AzureDevOpsFileLinkSettingsBuilder
Returns builder class for settings for linking to files hosted in Azure DevOps.
Inherited from FileLinkSettings
static
ForGitHub(Uri) GitHubFileLinkSettingsBuilder
Returns builder class for settings for linking to files hosted in GitHub.
Inherited from FileLinkSettings
static
ForPattern(string) FileLinkSettings
Returns settings to link files based on a custom pattern.
Inherited from FileLinkSettings
static
GetFileLink(IIssue) Uri
Returns the URL to the file on the source code hosting system for the issue issue.
Inherited from FileLinkSettings
WithRootPath(string) FileLinkSettings
Sets the root path for the files.

Extension Methods

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