Class YandexTrackerClient

Namespace

YandexTracker

Assembly

YandexTracker.dll

The default IYandexTrackerClient. Pass an HttpClient to let the application's factory manage it; without one the client creates its own and disposes of it.

public sealed class YandexTrackerClient : IYandexTrackerClient, IDisposable

Inheritance

object

YandexTrackerClient

Implements

IYandexTrackerClient

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

YandexTrackerClient(HttpClient, YandexTrackerClientOptions)

Creates a client over an HttpClient owned by the caller.

public YandexTrackerClient(HttpClient http, YandexTrackerClientOptions options)

Parameters

http HttpClient

The HTTP client to send requests with; it is not disposed with this client.

options YandexTrackerClientOptions

Connection settings; validated with Validate().

Exceptions

ArgumentNullException

http or options is null.

ArgumentException

The token or organization id is missing.

ArgumentOutOfRangeException

The retry count is negative.

YandexTrackerClient(YandexTrackerClientOptions)

Creates a client with its own HttpClient.

public YandexTrackerClient(YandexTrackerClientOptions options)

Parameters

options YandexTrackerClientOptions

Connection settings; validated with Validate().

Exceptions

ArgumentNullException

options is null.

ArgumentException

The token or organization id is missing.

ArgumentOutOfRangeException

The retry count is negative.

Properties

Issues

Issues: get, search, create, update, links, transitions and comments.

public IIssuesClient Issues { get; }

Property Value

IIssuesClient

Queues

The organization's queues.

public IQueuesClient Queues { get; }

Property Value

IQueuesClient

Statuses

The organization's issue statuses.

public IStatusesClient Statuses { get; }

Property Value

IStatusesClient

Users

The organization's users.

public IUsersClient Users { get; }

Property Value

IUsersClient

Methods

Dispose()

Disposes of the HttpClient when the client created it itself.

public void Dispose()

MyselfAsync(CancellationToken)

The user the token acts as; a cheap way to check the connection.

public Task<User> MyselfAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to cancel the request.

Returns

Task<User>

The current user.