Class CRUDClient<TSelf>

Namespace

Glitch9.IO.Networking.RESTApi

REST API client for performing CRUD operations.

public abstract class CRUDClient<TSelf> : RESTClient where TSelf : CRUDClient<TSelf>

Type Parameters

TSelf

Inheritance

object

RESTClient

CRUDClient<TSelf>

Derived

AIClient<TSelf>

Inherited Members

RESTClient.JsonSettings

RESTClient.Logger

RESTClient.LogLevel

RESTClient.Timeout

RESTClient.SSEParser

RESTClient.AllowBodyWithDELETE

RESTClient.clientSettings

RESTClient.LastRequest

RESTClient.LastEndpoint

RESTClient.POSTAsync<TReqBody>(RESTRequest<TReqBody>)

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

RESTClient.POSTAsync<TResBody>(RESTRequest)

RESTClient.POSTAsync(RESTRequest)

RESTClient.PUTAsync<TReqBody>(RESTRequest<TReqBody>)

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

RESTClient.GETAsync<TResBody>(RESTRequest)

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

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

RESTClient.DELETEAsync<TReqBody>(RESTRequest<TReqBody>)

RESTClient.DELETEAsync<TResBody>(RESTRequest)

RESTClient.DELETEAsync(RESTRequest)

RESTClient.HEADAsync<TReqBody>(RESTRequest<TReqBody>)

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

RESTClient.PATCHAsync<TReqBody>(RESTRequest<TReqBody>)

RESTClient.PATCHAsync<TResBody>(RESTRequest)

RESTClient.PATCHAsync(RESTRequest)

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

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

CRUDClient(CRUDClientSettings)

protected CRUDClient(CRUDClientSettings clientSettings)

Parameters

clientSettings CRUDClientSettings

Properties

BaseUrl

public string BaseUrl { get; }

Property Value

string

BetaVersion

The beta version of the API if available.

public string BetaVersion { get; }

Property Value

string

CRUDLogger

Special logger for logging CRUD operations.

public CRUDLogger CRUDLogger { get; }

Property Value

CRUDLogger

Name

The name of the API.

public string Name { get; }

Property Value

string

OnException

Event invoked when an error occurs during an API request.

public CRUDClient<TSelf>.ExceptionHandler OnException { get; set; }

Property Value

CRUDClient<TSelf>.ExceptionHandler

Version

The version of the API.

public string Version { get; }

Property Value

string

Methods

FormatErrorMessage(string)

Parses the error res from the API. Override this method to customize the error message parsing logic.

protected abstract string FormatErrorMessage(string errorJson)

Parameters

errorJson string

Returns

string

The error message.

GetApiKey()

public string GetApiKey()

Returns

string

HandleException(Exception)

public void HandleException(Exception exception)

Parameters

exception Exception

IsDeletedPredicate(RESTResponse)

Override this method to handle the status of a Delete operation.

protected abstract bool IsDeletedPredicate(RESTResponse res)

Parameters

res RESTResponse

Returns

bool