Class RESTClient

Namespace

Glitch9.IO.Networking.RESTApi

A REST client class for handling various types of REST API requests.

public class RESTClient

Inheritance

object

RESTClient

Derived

CRUDClient<TSelf>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

LogExtensions.LogIfNotSetInInspector<T>(T, string, string)

LogExtensions.LogIfNull<T>(T, string, string)

LogExtensions.LogIfSetInInspector<T>(T, string, string)

SystemExtensions.ToSenderName(object)

TypeExtensions.IsInteger(object)

Constructors

RESTClient(RESTClientSettings)

Constructor to initialize RESTClient with optional JSON settings.

public RESTClient(RESTClientSettings clientSettings = null)

Parameters

clientSettings RESTClientSettings

Fields

clientSettings

protected readonly RESTClientSettings clientSettings

Field Value

RESTClientSettings

Properties

AllowBodyWithDELETE

public bool AllowBodyWithDELETE { get; }

Property Value

bool

JsonSettings

public JsonSerializerSettings JsonSettings { get; }

Property Value

JsonSerializerSettings

LastEndpoint

public string LastEndpoint { get; set; }

Property Value

string

LastRequest

public string LastRequest { get; set; }

Property Value

string

LogLevel

public RESTLogLevel LogLevel { get; }

Property Value

RESTLogLevel

Logger

public RESTLogger Logger { get; }

Property Value

RESTLogger

SSEParser

public SSEParser SSEParser { get; }

Property Value

SSEParser

Timeout

public TimeSpan Timeout { get; }

Property Value

TimeSpan

Methods

DELETEAsync(RESTRequest)

public UniTask<RESTResponse> DELETEAsync(RESTRequest request)

Parameters

request RESTRequest

Returns

UniTask<RESTResponse>

DELETEAsync<TResBody>(RESTRequest)

public UniTask<RESTResponse<TResBody>> DELETEAsync<TResBody>(RESTRequest request)

Parameters

request RESTRequest

Returns

UniTask<RESTResponse<TResBody>>

Type Parameters

TResBody

DELETEAsync<TReqBody>(RESTRequest<TReqBody>)

Sends a DELETE request with a generic request type and default response and error types.

public UniTask<RESTResponse> DELETEAsync<TReqBody>(RESTRequest<TReqBody> request)

Parameters

request RESTRequest<TReqBody>

Request object.

Returns

UniTask<RESTResponse>

Response result.

Type Parameters

TReqBody

Request body type.

DELETEAsync<TReqBody, TResBody>(RESTRequest<TReqBody>)

Sends a DELETE request with a generic request and response type.

public UniTask<RESTResponse<TResBody>> DELETEAsync<TReqBody, TResBody>(RESTRequest<TReqBody> request)

Parameters

request RESTRequest<TReqBody>

Request object.

Returns

UniTask<RESTResponse<TResBody>>

Response result.

Type Parameters

TReqBody

Request body type.

TResBody

Response body type.

GETAsync<TResBody>(RESTRequest)

Sends a GET request with a generic request type and default response and error types.

public UniTask<RESTResponse<TResBody>> GETAsync<TResBody>(RESTRequest request)

Parameters

request RESTRequest

Request object.

Returns

UniTask<RESTResponse<TResBody>>

Response result.

Type Parameters

TResBody

Response body type.

GETAsync<TReqBody, TResBody>(RESTRequest<TReqBody>)

Sends a GET request with a generic request and response type.

public UniTask<RESTResponse<TResBody>> GETAsync<TReqBody, TResBody>(RESTRequest<TReqBody> request)

Parameters

request RESTRequest<TReqBody>

Request object.

Returns

UniTask<RESTResponse<TResBody>>

Response result.

Type Parameters

TReqBody

Request body type.

TResBody

Response body type.

HEADAsync<TReqBody>(RESTRequest<TReqBody>)

Sends a HEAD request with a generic request type and default response and error types.

public UniTask<RESTResponse> HEADAsync<TReqBody>(RESTRequest<TReqBody> request)

Parameters

request RESTRequest<TReqBody>

Request object.

Returns

UniTask<RESTResponse>

Response result.

Type Parameters

TReqBody

Request body type.

HEADAsync<TReqBody, TResBody>(RESTRequest<TReqBody>)

Sends a HEAD request with a generic request and response type.

public UniTask<RESTResponse<TResBody>> HEADAsync<TReqBody, TResBody>(RESTRequest<TReqBody> request)

Parameters

request RESTRequest<TReqBody>

Request object.

Returns

UniTask<RESTResponse<TResBody>>

Response result.

Type Parameters

TReqBody

Request body type.

TResBody

Response body type.

PATCHAsync(RESTRequest)

public UniTask<RESTResponse> PATCHAsync(RESTRequest request)

Parameters

request RESTRequest

Returns

UniTask<RESTResponse>

PATCHAsync<TResBody>(RESTRequest)

public UniTask<RESTResponse<TResBody>> PATCHAsync<TResBody>(RESTRequest request)

Parameters

request RESTRequest

Returns

UniTask<RESTResponse<TResBody>>

Type Parameters

TResBody

PATCHAsync<TReqBody>(RESTRequest<TReqBody>)

Sends a PATCH request with a generic request type and default response and error types.

public UniTask<RESTResponse> PATCHAsync<TReqBody>(RESTRequest<TReqBody> request)

Parameters

request RESTRequest<TReqBody>

Request object.

Returns

UniTask<RESTResponse>

Response result.

Type Parameters

TReqBody

Request body type.

PATCHAsync<TReqBody, TResBody>(RESTRequest<TReqBody>)

Sends a PATCH request with generic request, response, and error types.

public UniTask<RESTResponse<TResBody>> PATCHAsync<TReqBody, TResBody>(RESTRequest<TReqBody> request)

Parameters

request RESTRequest<TReqBody>

Request object.

Returns

UniTask<RESTResponse<TResBody>>

Response result.

Type Parameters

TReqBody

Request body type.

TResBody

Response body type.

POSTAsync(RESTRequest)

public UniTask<RESTResponse> POSTAsync(RESTRequest request)

Parameters

request RESTRequest

Returns

UniTask<RESTResponse>

POSTAsync<TResBody>(RESTRequest)

public UniTask<RESTResponse<TResBody>> POSTAsync<TResBody>(RESTRequest request)

Parameters

request RESTRequest

Returns

UniTask<RESTResponse<TResBody>>

Type Parameters

TResBody

POSTAsync<TReqBody>(RESTRequest<TReqBody>)

Sends a POST request with a body and no response body.

public UniTask<RESTResponse> POSTAsync<TReqBody>(RESTRequest<TReqBody> request)

Parameters

request RESTRequest<TReqBody>

Request object.

Returns

UniTask<RESTResponse>

Response result.

Type Parameters

TReqBody

Request body type.

POSTAsync<TReqBody, TResBody>(RESTRequest<TReqBody>)

Sends a POST request with a generic request and response type.

public UniTask<RESTResponse<TResBody>> POSTAsync<TReqBody, TResBody>(RESTRequest<TReqBody> request)

Parameters

request RESTRequest<TReqBody>

Request object.

Returns

UniTask<RESTResponse<TResBody>>

Response result.

Type Parameters

TReqBody

Request body type.

TResBody

Response body type.

PUTAsync<TReqBody>(RESTRequest<TReqBody>)

Sends a PUT request with a generic request type and default response and error types.

public UniTask<RESTResponse> PUTAsync<TReqBody>(RESTRequest<TReqBody> request)

Parameters

request RESTRequest<TReqBody>

Request object.

Returns

UniTask<RESTResponse>

Response result.

Type Parameters

TReqBody

Request body type.

PUTAsync<TReqBody, TResBody>(RESTRequest<TReqBody>)

Sends a PUT request with a generic request and response type.

public UniTask<RESTResponse<TResBody>> PUTAsync<TReqBody, TResBody>(RESTRequest<TReqBody> request)

Parameters

request RESTRequest<TReqBody>

Request object.

Returns

UniTask<RESTResponse<TResBody>>

Response result.

Type Parameters

TReqBody

Request body type.

TResBody

Response body type.