Class PersonClient

Client for interacting with the Person resource.

public class PersonClient : SingletonResourceClient<Person, PersonResource, PersonResponse>

Inheritance: object

ResourceClient<Person>

SingletonResourceClient<Person, PersonResource, PersonResponse>

PersonClient

Inherited Members: SingletonResourceClient<Person, PersonResource, PersonResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Person, PersonResource, PersonResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Person, PersonResource, PersonResponse>.PatchAsync(Person, CancellationToken)

SingletonResourceClient<Person, PersonResource, PersonResponse>.PatchAsync(JsonApiDocument<PersonResource>, CancellationToken)

SingletonResourceClient<Person, PersonResource, PersonResponse>.DeleteAsync(CancellationToken)

ResourceClient<Person>.AddQueryParameter(string, string)

ResourceClient<Person>.ReplaceQueryParameter(string, string)

ResourceClient<Person>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Person>.Uri

ResourceClient<Person>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Client for interacting with the Person resource.

public PersonClient(HttpClient httpClient, Uri uri)

Adds a custom query parameter to the request URI.

public PersonClient AddCustomParameter(string parameter, string value)

Removes the entire query string from the request URI.

public PersonClient ClearParameters()

Fetches the Person resource asynchronously.

public Task<PersonResponse> GetAsync(CancellationToken cancellationToken = default)

cancellationToken CancellationToken: A token to monitor for cancellation requests.

Task<PersonResponse>: A task representing the asynchronous operation, containing the Person resource.

JsonApiException: Thrown when the HTTP response indicates a failure status code.