Class NoteClient

Client for interacting with the Note resource.

public class NoteClient : SingletonResourceClient<Note, NoteResource, NoteResponse>

Inheritance: object

ResourceClient<Note>

SingletonResourceClient<Note, NoteResource, NoteResponse>

NoteClient

Inherited Members: SingletonResourceClient<Note, NoteResource, NoteResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Note, NoteResource, NoteResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Note, NoteResource, NoteResponse>.PatchAsync(Note, CancellationToken)

SingletonResourceClient<Note, NoteResource, NoteResponse>.PatchAsync(JsonApiDocument<NoteResource>, CancellationToken)

SingletonResourceClient<Note, NoteResource, NoteResponse>.DeleteAsync(CancellationToken)

ResourceClient<Note>.AddQueryParameter(string, string)

ResourceClient<Note>.ReplaceQueryParameter(string, string)

ResourceClient<Note>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Note>.Uri

ResourceClient<Note>.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 Note resource.

public NoteClient(HttpClient httpClient, Uri uri)

Adds a custom query parameter to the request URI.

public NoteClient AddCustomParameter(string parameter, string value)

Removes the entire query string from the request URI.

public NoteClient ClearParameters()

Fetches the Note resource asynchronously.

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

cancellationToken CancellationToken: A token to monitor for cancellation requests.

Task<NoteResponse>: A task representing the asynchronous operation, containing the Note resource.

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