Class RestClientExtensions

IRestClient extensions for http requests/responses and url construction

Inheritance

System.Object

RestClientExtensions

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: BlazorFocused.Extensions

Assembly: BlazorFocused.Client.dll

Syntax

public static class RestClientExtensions

Methods

| Improve this Doc View Source

DeleteAsync<T>(IRestClient, Action<IRestClientUrlBuilder>)

Performs DELETE http request

Declaration

public static Task<T> DeleteAsync<T>(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request

Returns

Type	Description
Task<T>	Http response body of type

Type Parameters

Name	Description
T	Object type of response from http request

Remarks

Rules/Details on DeleteAsync<T>(String) apply

| Improve this Doc View Source

DeleteTaskAsync(IRestClient, Action<IRestClientUrlBuilder>)

Performs DELETE http request

Declaration

public static Task DeleteTaskAsync(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request

Returns

Type	Description
Task	Task for completion detection

Remarks

Rules/Details on DeleteTaskAsync(String) apply

| Improve this Doc View Source

GetAsync<T>(IRestClient, Action<IRestClientUrlBuilder>)

Performs GET http request

Declaration

public static Task<T> GetAsync<T>(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request

Returns

Type	Description
Task<T>	Http response body of type

Type Parameters

Name	Description
T	Object type of response from http request

Remarks

Rules/Details on GetAsync<T>(String) apply

| Improve this Doc View Source

PatchAsync<T>(IRestClient, Action<IRestClientUrlBuilder>, Object)

Performs PATCH http request

Declaration

public static Task<T> PatchAsync<T>(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request
System.Object	data	Http request object body

Returns

Type	Description
Task<T>	Http response body of type

Type Parameters

Name	Description
T	Object type of response from http request

Remarks

Rules/Details on PatchAsync<T>(String, Object) apply

| Improve this Doc View Source

PatchTaskAsync(IRestClient, Action<IRestClientUrlBuilder>, Object)

Performs PATCH http request

Declaration

public static Task PatchTaskAsync(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request
System.Object	data	Http request object body

Returns

Type	Description
Task	Task for completion detection

Remarks

Rules/Details on PatchTaskAsync(String, Object) apply

| Improve this Doc View Source

PostAsync<T>(IRestClient, Action<IRestClientUrlBuilder>, Object)

Performs POST http request

Declaration

public static Task<T> PostAsync<T>(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request
System.Object	data	Http request object body

Returns

Type	Description
Task<T>	Http response body of type

Type Parameters

Name	Description
T	Object type of response from http request

Remarks

Rules/Details on PostAsync<T>(String, Object) apply

| Improve this Doc View Source

PostTaskAsync(IRestClient, Action<IRestClientUrlBuilder>, Object)

Performs POST http request

Declaration

public static Task PostTaskAsync(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request
System.Object	data	Http request object body

Returns

Type	Description
Task	Task for completion detection

Remarks

Rules/Details on PostAsync<T>(String, Object) apply

| Improve this Doc View Source

PutAsync<T>(IRestClient, Action<IRestClientUrlBuilder>, Object)

Performs PUT http request

Declaration

public static Task<T> PutAsync<T>(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request
System.Object	data	Http request object body

Returns

Type	Description
Task<T>	Http response body of type

Type Parameters

Name	Description
T	Object type of response from http request

Remarks

Rules/Details on PutAsync<T>(String, Object) apply

| Improve this Doc View Source

PutTaskAsync(IRestClient, Action<IRestClientUrlBuilder>, Object)

Performs PUT http request

Declaration

public static Task PutTaskAsync(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request
System.Object	data	Http request object body

Returns

Type	Description
Task	Task for completion detection

Remarks

Rules/Details on PutAsync<T>(String, Object) apply

| Improve this Doc View Source

TryDeleteAsync<T>(IRestClient, Action<IRestClientUrlBuilder>)

Performs DELETE http request

Declaration

public static Task<RestClientResponse<T>> TryDeleteAsync<T>(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request

Returns

Type	Description
Task<RestClientResponse<T>>	Http response attributes including value, status code, or any exceptions. See RestClientResponse<T>

Type Parameters

Name	Description
T	Object type of response from http request

Remarks

Rules/Details on TryDeleteAsync<T>(IRestClient, String) apply

| Improve this Doc View Source

TryDeleteAsync<T>(IRestClient, String)

Performs DELETE http request

Declaration

public static Task<RestClientResponse<T>> TryDeleteAsync<T>(this IRestClient restClient, string relativeUrl)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
System.String	relativeUrl	Relative url for http request

Returns

Type	Description
Task<RestClientResponse<T>>	Http response attributes including value, status code, or any exceptions. See RestClientResponse<T>

Type Parameters

Name	Description
T	Object type of response from http request

Remarks

If request is successful, value is returned. If request is not successful, exception is returned. Success is indicated by "IsValid" property. See RestClientResponse<T>

| Improve this Doc View Source

TryDeleteTaskAsync(IRestClient, Action<IRestClientUrlBuilder>)

Performs DELETE http request

Declaration

public static Task<RestClientTask> TryDeleteTaskAsync(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request

Returns

Type	Description
Task<RestClientTask>	RestClientTask with http response attributes including status code or any exceptions.

Remarks

Rules/Details on TryDeleteAsync<T>(IRestClient, String) apply

| Improve this Doc View Source

TryDeleteTaskAsync(IRestClient, String)

Performs DELETE http request

Declaration

public static async Task<RestClientTask> TryDeleteTaskAsync(this IRestClient restClient, string relativeUrl)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
System.String	relativeUrl	Relative url for http request

Returns

Type	Description
Task<RestClientTask>	RestClientTask with http response attributes including status code or any exceptions. NOTE: Use this when not expecting to receive a deserialized response object. To received deserialized response object, use extension TryDeleteAsync<T>(IRestClient, String)

| Improve this Doc View Source

TryGetAsync<T>(IRestClient, Action<IRestClientUrlBuilder>)

Performs GET http request

Declaration

public static Task<RestClientResponse<T>> TryGetAsync<T>(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request

Returns

Type	Description
Task<RestClientResponse<T>>	Http response attributes including value, status code, or any exceptions. See RestClientResponse<T>

Type Parameters

Name	Description
T	Object type of response from http request

Remarks

Rules/Details on TryGetAsync<T>(IRestClient, String) apply

| Improve this Doc View Source

TryGetAsync<T>(IRestClient, String)

Performs GET http request

Declaration

public static Task<RestClientResponse<T>> TryGetAsync<T>(this IRestClient restClient, string relativeUrl)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
System.String	relativeUrl	Relative url for http request

Returns

Type	Description
Task<RestClientResponse<T>>	Http response attributes including body, status code, or any exceptions that occurred. See RestClientResponse<T>

Type Parameters

Name	Description
T	Object type of response from http request

Remarks

If request is successful, value is returned. If request is not successful, exception is returned. Success is indicated by "IsValid" property. See RestClientResponse<T>

| Improve this Doc View Source

TryPatchAsync<T>(IRestClient, Action<IRestClientUrlBuilder>, Object)

Performs PATCH http request

Declaration

public static Task<RestClientResponse<T>> TryPatchAsync<T>(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request
System.Object	data	Http request object body

Returns

Type	Description
Task<RestClientResponse<T>>	Http response attributes including value, status code, or any exceptions. See RestClientResponse<T>

Type Parameters

Name	Description
T	Object type of response from http request

Remarks

Rules/Details on TryPatchAsync<T>(IRestClient, String, Object) apply

| Improve this Doc View Source

TryPatchAsync<T>(IRestClient, String, Object)

Performs PATCH http request

Declaration

public static Task<RestClientResponse<T>> TryPatchAsync<T>(this IRestClient restClient, string relativeUrl, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
System.String	relativeUrl	Relative url for http request
System.Object	data	Http request object body

Returns

Type	Description
Task<RestClientResponse<T>>	Http response attributes including body, status code, or any exceptions that occurred. See RestClientResponse<T>

Type Parameters

Name	Description
T	Object type of response from http request

Remarks

If request is successful, value is returned. If request is not successful, exception is returned. Success is indicated by "IsValid" property. See RestClientResponse<T>

| Improve this Doc View Source

TryPatchTaskAsync(IRestClient, Action<IRestClientUrlBuilder>, Object)

Performs PATCH http request

Declaration

public static Task<RestClientTask> TryPatchTaskAsync(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request
System.Object	data	Http request object body

Returns

Type	Description
Task<RestClientTask>	RestClientTask with http response attributes including status code or any exceptions.

Remarks

Rules/Details on TryPatchTaskAsync(IRestClient, String, Object) apply

| Improve this Doc View Source

TryPatchTaskAsync(IRestClient, String, Object)

Performs PATCH http request

Declaration

public static async Task<RestClientTask> TryPatchTaskAsync(this IRestClient restClient, string relativeUrl, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
System.String	relativeUrl	Relative url for http request
System.Object	data	Http request object body

Returns

Type	Description
Task<RestClientTask>	RestClientTask with http response attributes including status code or any exceptions. NOTE: Use this when not expecting to receive a deserialized response object. To received deserialized response object, use extension TryPatchAsync<T>(IRestClient, String, Object)

| Improve this Doc View Source

TryPostAsync<T>(IRestClient, Action<IRestClientUrlBuilder>, Object)

Performs POST http request

Declaration

public static Task<RestClientResponse<T>> TryPostAsync<T>(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request
System.Object	data	Http request object body

Returns

Type	Description
Task<RestClientResponse<T>>	Http response attributes including value, status code, or any exceptions. See RestClientResponse<T>

Type Parameters

Name	Description
T	Object type of response from http request

Remarks

Rules/Details on TryPostAsync<T>(IRestClient, String, Object) apply

| Improve this Doc View Source

TryPostAsync<T>(IRestClient, String, Object)

Performs POST http request

Declaration

public static Task<RestClientResponse<T>> TryPostAsync<T>(this IRestClient restClient, string relativeUrl, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
System.String	relativeUrl	Relative url for http request
System.Object	data	Http request object body

Returns

Type	Description
Task<RestClientResponse<T>>	Http response attributes including body, status code, or any exceptions that occurred. See RestClientResponse<T>

Type Parameters

Name	Description
T	Object type of response from http request

Remarks

If request is successful, value is returned. If request is not successful, exception is returned. Success is indicated by "IsValid" property. See RestClientResponse<T>

| Improve this Doc View Source

TryPostTaskAsync(IRestClient, Action<IRestClientUrlBuilder>, Object)

Performs POST http request

Declaration

public static Task<RestClientTask> TryPostTaskAsync(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request
System.Object	data	Http request object body

Returns

Type	Description
Task<RestClientTask>	RestClientTask with http response attributes including status code or any exceptions.

Remarks

Rules/Details on TryPostTaskAsync(IRestClient, String, Object) apply

| Improve this Doc View Source

TryPostTaskAsync(IRestClient, String, Object)

Performs POST http request

Declaration

public static async Task<RestClientTask> TryPostTaskAsync(this IRestClient restClient, string relativeUrl, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
System.String	relativeUrl	Relative url for http request
System.Object	data	Http request object body

Returns

Type	Description
Task<RestClientTask>	RestClientTask with http response attributes including status code or any exceptions. NOTE: Use this when not expecting to receive a deserialized response object. To received deserialized response object, use extension TryPostAsync<T>(IRestClient, String, Object)

| Improve this Doc View Source

TryPutAsync<T>(IRestClient, Action<IRestClientUrlBuilder>, Object)

Performs PUT http request

Declaration

public static Task<RestClientResponse<T>> TryPutAsync<T>(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request
System.Object	data	Http request object body

Returns

Type	Description
Task<RestClientResponse<T>>	Http response attributes including value, status code, or any exceptions. See RestClientResponse<T>

Type Parameters

Name	Description
T	Object type of response from http request

Remarks

Rules/Details on TryPutAsync<T>(IRestClient, String, Object) apply

| Improve this Doc View Source

TryPutAsync<T>(IRestClient, String, Object)

Performs PUT http request

Declaration

public static Task<RestClientResponse<T>> TryPutAsync<T>(this IRestClient restClient, string relativeUrl, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
System.String	relativeUrl	Relative url for http request
System.Object	data	Http request object body

Returns

Type	Description
Task<RestClientResponse<T>>	Http response attributes including body, status code, or any exceptions that occurred. See RestClientResponse<T>

Type Parameters

Name	Description
T	Object type of response from http request

Remarks

If request is successful, value is returned. If request is not successful, exception is returned. Success is indicated by "IsValid" property. See RestClientResponse<T>

| Improve this Doc View Source

TryPutTaskAsync(IRestClient, Action<IRestClientUrlBuilder>, Object)

Performs PUT http request

Declaration

public static Task<RestClientTask> TryPutTaskAsync(this IRestClient restClient, Action<IRestClientUrlBuilder> urlBuilder, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
Action<IRestClientUrlBuilder>	urlBuilder	IRestClientUrlBuilder used to construct relative or absolute url for request
System.Object	data	Http request object body

Returns

Type	Description
Task<RestClientTask>	RestClientTask with http response attributes including status code or any exceptions.

Remarks

Rules/Details on TryPutTaskAsync(IRestClient, String, Object) apply

| Improve this Doc View Source

TryPutTaskAsync(IRestClient, String, Object)

Performs PUT http request

Declaration

public static async Task<RestClientTask> TryPutTaskAsync(this IRestClient restClient, string relativeUrl, object data)

Parameters

Type	Name	Description
IRestClient	restClient	IRestClient implementation being extended
System.String	relativeUrl	Relative url for http request
System.Object	data	Http request object body

Returns

Type	Description
Task<RestClientTask>	RestClientTask with http response attributes including status code or any exceptions. NOTE: Use this when not expecting to receive a deserialized response object. To received deserialized response object, use extension TryPutAsync<T>(IRestClient, String, Object)