Class YandexTrackerClientOptions

Namespace

YandexTracker

Assembly

YandexTracker.dll

Connection settings for YandexTrackerClient.

public sealed class YandexTrackerClientOptions

Inheritance

object

YandexTrackerClientOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Fields

DefaultBaseAddress

The default API address, https://api.tracker.yandex.net/.

public static readonly Uri DefaultBaseAddress

Field Value

Uri

Properties

AcceptLanguage

The language of texts in responses (status names, errors); null keeps the organization's default.

public string? AcceptLanguage { get; set; }

Property Value

string

BaseAddress

The API address; request paths such as v2/issues are resolved against it.

public Uri BaseAddress { get; set; }

Property Value

Uri

MaxRetries

Maximum retries after a 429 for any request, or after a 5xx or network error for reads and searches. Defaults to 3; zero disables retries. Cancellation and authentication failures are not retried.

public int MaxRetries { get; set; }

Property Value

int

OrganizationId

The organization id the token works in.

public string OrganizationId { get; set; }

Property Value

string

OrganizationKind

Whether OrganizationId is a Yandex 360 or a Yandex Cloud organization.

public YandexTrackerOrganizationKind OrganizationKind { get; set; }

Property Value

YandexTrackerOrganizationKind

RetryDelay

The first pause before a retry when the server names none; it doubles on every next attempt.

public TimeSpan RetryDelay { get; set; }

Property Value

TimeSpan

Token

The access token.

public string Token { get; set; }

Property Value

string

TokenType

Whether Token is an OAuth or an IAM token. Defaults to OAuth.

public YandexTrackerTokenType TokenType { get; set; }

Property Value

YandexTrackerTokenType

Methods

Validate()

Checks that the connection is fully described. Without a token or an organization the API would answer with an opaque 401, so the client refuses to start instead.

public void Validate()

Exceptions

ArgumentException

The token or the organization id is empty.

ArgumentOutOfRangeException

MaxRetries is negative.