Table of Contents

Class RestClient

Namespace
Lers.Http
Assembly
Lers.System.dll

Клиент для работы с WEB API сервера ЛЭРС УЧЁТ.

public class RestClient : RestClientBase, IDisposable
Inheritance
RestClientBase
RestClient
Implements
Inherited Members
Extension Methods

Constructors

RestClient()

Конструктор.

public RestClient()

RestClient(ProxySettings)

Конструктор.

public RestClient(ProxySettings proxy)

Parameters

proxy ProxySettings

RestClient(ProxySettings, HttpClientHandler?)

Конструктор.

public RestClient(ProxySettings proxy, HttpClientHandler? handler)

Parameters

proxy ProxySettings
handler HttpClientHandler

RestClient(Func<HttpClientHandler>)

Конструктор.

public RestClient(Func<HttpClientHandler> handlerFactory)

Parameters

handlerFactory Func<HttpClientHandler>

RestClient(IWebProxy?, bool)

Конструктор.

public RestClient(IWebProxy? webProxy, bool useDefaultCredentials = false)

Parameters

webProxy IWebProxy
useDefaultCredentials bool

Указывает, что нужно использовать Windows аутентификацию.

Properties

AcceptCompressed

Указывает, что клиент будет принимать от сервера сжатые ответы.

public bool AcceptCompressed { get; set; }

Property Value

bool

BaseAddress

Базовый адрес веб-сервера ЛЭРС УЧЁТ.

public Uri BaseAddress { get; set; }

Property Value

Uri

Http

Возвращает базовый HTTP клиент.

public HttpClient Http { get; }

Property Value

HttpClient

Timeout

Таймаут на выполнение запроса (секунды)

public TimeSpan Timeout { get; set; }

Property Value

TimeSpan

Version

Версия клиента, которая будет отправлена в заголовках запроса.

public Version? Version { get; set; }

Property Value

Version

Methods

Authenticate(AuthenticationInfo, string, CancellationToken)

Авторизует пользователя и сохраняет его токен.

public Task<LoginResponseParameters> Authenticate(AuthenticationInfo authInfo, string application, CancellationToken cancellationToken)

Parameters

authInfo AuthenticationInfo
application string
cancellationToken CancellationToken

Returns

Task<LoginResponseParameters>

ClearToken()

Удаляет сохранённый токен авторизации.

public void ClearToken()

CreateCopy(int)

Создаёт копию клиента.

public RestClient CreateCopy(int newTimeoutSeconds)

Parameters

newTimeoutSeconds int

Новый таймаут для клиента (в секундах).

Returns

RestClient

CreateCopy(TimeSpan?)

Создаёт копию клиента.

public RestClient CreateCopy(TimeSpan? newTimeout = null)

Parameters

newTimeout TimeSpan?

Новый таймаут для клиента.

Returns

RestClient

DeleteAsync(string)

Выполняет удаление указанной сущности.

public Task DeleteAsync(string apiRoute)

Parameters

apiRoute string

Returns

Task

Dispose()

Освобождает ресурсы объекта.

public override void Dispose()

GetAsync(string)

Асинхронно отправляет серверу запрос GET.

public Task<HttpResponseMessage> GetAsync(string apiRoute)

Parameters

apiRoute string

Returns

Task<HttpResponseMessage>

GetAsync<TResult>(string)

Асинхронно отправляет серверу запрос GET.

public Task<TResult> GetAsync<TResult>(string apiRoute)

Parameters

apiRoute string

Returns

Task<TResult>

Type Parameters

TResult

GetHub(string)

Возвращает хаб с подпиской на событие по указанному URI.

public HubConnection GetHub(string url)

Parameters

url string

Returns

HubConnection

IsNoConnectionException(HttpRequestException)

Проверяет что исключение является исключением связанным с отсутствием соединения с сервером.

public static bool IsNoConnectionException(HttpRequestException exc)

Parameters

exc HttpRequestException

Ошибка для проверки.

Returns

bool

true если ошибка является ошибкой связанной с отсутствием соединения с сервером, иначе false.

PostAsync(string, object)

Асинхронно отправляет серверу запрос POST.

public Task<HttpResponseMessage> PostAsync(string apiRoute, object data)

Parameters

apiRoute string
data object

Returns

Task<HttpResponseMessage>

PostAsync(string, object, CancellationToken)

Асинхронно отправляет серверу запрос POST.

public Task<HttpResponseMessage> PostAsync(string apiRoute, object data, CancellationToken cancellationToken)

Parameters

apiRoute string
data object
cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

PostAsync<TResult>(string, object)

Асинхронно отправляет серверу запрос POST.

public Task<TResult> PostAsync<TResult>(string apiRoute, object data)

Parameters

apiRoute string
data object

Returns

Task<TResult>

Type Parameters

TResult

PostAsync<TResult>(string, object, CancellationToken)

Асинхронно отправляет серверу запрос POST.

public Task<TResult> PostAsync<TResult>(string apiRoute, object data, CancellationToken cancellationToken)

Parameters

apiRoute string
data object
cancellationToken CancellationToken

Returns

Task<TResult>

Type Parameters

TResult

PutAsync(string, object, CancellationToken)

Асинхронно отправляет серверу запрос PUT.

public Task<HttpResponseMessage> PutAsync(string apiRoute, object data, CancellationToken cancellationToken)

Parameters

apiRoute string
data object
cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

PutAsync(string, object, TimeSpan)

Асинхронно отправляет серверу запрос PUT.

public Task<HttpResponseMessage> PutAsync(string apiRoute, object data, TimeSpan timeout)

Parameters

apiRoute string

Маршрут для выполнения.

data object

Передаваемое тело данных.

timeout TimeSpan

Таймаут выполнения операции.

Returns

Task<HttpResponseMessage>

SendAsync(HttpRequestMessage, HttpCompletionOption, CancellationToken)

Отправляет запрос серверу.

public override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, HttpCompletionOption completionOption, CancellationToken cancellationToken)

Parameters

request HttpRequestMessage
completionOption HttpCompletionOption
cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

SetToken(string?)

Устанавливает токен безопасности, используемый для авторизации.

public void SetToken(string? token)

Parameters

token string

Events

InvalidTokenExceptionHandled

Возникает при перехвате ошибки неверного токена.

public event EventHandler<LersServerException>? InvalidTokenExceptionHandled

Event Type

EventHandler<LersServerException>