Class OwnerClient

Namespace

Crews.PlanningCenter.Api.Groups.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Owner resource.

public class OwnerClient : SingletonResourceClient<Owner, OwnerResource, OwnerResponse>

Inheritance

object

ResourceClient<Owner>

SingletonResourceClient<Owner, OwnerResource, OwnerResponse>

OwnerClient

Inherited Members

SingletonResourceClient<Owner, OwnerResource, OwnerResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Owner, OwnerResource, OwnerResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Owner, OwnerResource, OwnerResponse>.PatchAsync(Owner, CancellationToken)

SingletonResourceClient<Owner, OwnerResource, OwnerResponse>.PatchAsync(JsonApiDocument<OwnerResource>, CancellationToken)

SingletonResourceClient<Owner, OwnerResource, OwnerResponse>.DeleteAsync(CancellationToken)

ResourceClient<Owner>.AddQueryParameter(string, string)

ResourceClient<Owner>.ReplaceQueryParameter(string, string)

ResourceClient<Owner>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Owner>.Uri

ResourceClient<Owner>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

OwnerClient(HttpClient, Uri)

Client for interacting with the Owner resource.

public OwnerClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public OwnerClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

OwnerClient

The current OwnerClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public OwnerClient ClearParameters()

Returns

OwnerClient

The current OwnerClient instance.

GetAsync(CancellationToken)

Fetches the Owner resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<OwnerResponse>

A task representing the asynchronous operation, containing the Owner resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.