MarkdownJiraLinkOptions Class

Where the links of MarkdownExtensions.JiraLinks go: {BaseUrl}/{BasePath}/{issue}.

public sealed class MarkdownJiraLinkOptions : IEquatable<MarkdownJiraLinkOptions>
Implements

Constructors

NameDescription
MarkdownJiraLinkOptions()

MarkdownJiraLinkOptions()

MarkdownJiraLinkOptions.cs
public MarkdownJiraLinkOptions()

No documentation is available.

Properties

NameDescription
BasePathGets the path of the issues on the site, /browse by default.
BaseUrlGets the URL of the Jira site, such as https://example.atlassian.net.
DefaultGets options without a base URL: the links are /browse/PROJ-123.
OpenInNewWindowGets a value indicating whether the links have target="_blank", which is the default.

Gets the path of the issues on the site, /browse by default.

public string BasePath { get; init; }

Property value

string

Gets the URL of the Jira site, such as https://example.atlassian.net.

public string BaseUrl { get; init; }

Property value

string

Gets options without a base URL: the links are /browse/PROJ-123.

public static MarkdownJiraLinkOptions Default { get; }

Gets a value indicating whether the links have target="_blank", which is the default.

public bool OpenInNewWindow { get; init; }

Property value

bool

Methods

NameDescription
Equals(MarkdownJiraLinkOptions?)
Equals(object?)
GetDestination(string)Gets the destination of the link to an issue, such as PROJ-123.
GetHashCode()
ToString()

Equals overloads

Equals(MarkdownJiraLinkOptions?)

public bool Equals(MarkdownJiraLinkOptions? other)
Parameters
other MarkdownJiraLinkOptions?
Returns

bool

No documentation is available.

Equals(object?)

public override bool Equals(object? obj)
Parameters
obj object?
Returns

bool

No documentation is available.

GetDestination(string)

MarkdownJiraLinkOptions.cs

Gets the destination of the link to an issue, such as PROJ-123.

public string GetDestination(string issue)

Parameters

issue string

Returns

string

Exceptions

ArgumentNullException
issue is null.

GetHashCode()

public override int GetHashCode()

Returns

int

No documentation is available.

ToString()

public override string ToString()

Returns

string

No documentation is available.

Operators

NameDescription
operator ==(MarkdownJiraLinkOptions?, MarkdownJiraLinkOptions?)
operator !=(MarkdownJiraLinkOptions?, MarkdownJiraLinkOptions?)

operator ==(MarkdownJiraLinkOptions?, MarkdownJiraLinkOptions?)

public static bool operator ==(MarkdownJiraLinkOptions? left, MarkdownJiraLinkOptions? right)

No documentation is available.

operator !=(MarkdownJiraLinkOptions?, MarkdownJiraLinkOptions?)

public static bool operator !=(MarkdownJiraLinkOptions? left, MarkdownJiraLinkOptions? right)

No documentation is available.