FileLinkSettings Class

Summary

Settings how issues should be linked to files.
Assembly
Cake.Issues.dll
Namespace
Cake.Issues
Base Types
  • Object
Derived Types
graph BT Type-->Base0["Object"] Type["FileLinkSettings"] class Type type-node Derived0["FileLinkOptionalSettingsBuilder"]-->Type click Derived0 "/api/Cake.Issues.FileLinking/FileLinkOptionalSettingsBuilder"

Syntax

public class FileLinkSettings

Methods

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

Extension Methods

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