Class AvailableEventClient

Namespace

Crews.PlanningCenter.Api.Webhooks.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the AvailableEvent resource.

public class AvailableEventClient : SingletonResourceClient<AvailableEvent, AvailableEventResource, AvailableEventResponse>

Inheritance

object

ResourceClient<AvailableEvent>

SingletonResourceClient<AvailableEvent, AvailableEventResource, AvailableEventResponse>

AvailableEventClient

Inherited Members

SingletonResourceClient<AvailableEvent, AvailableEventResource, AvailableEventResponse>.GetAsync(CancellationToken)

SingletonResourceClient<AvailableEvent, AvailableEventResource, AvailableEventResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<AvailableEvent, AvailableEventResource, AvailableEventResponse>.PatchAsync(AvailableEvent, CancellationToken)

SingletonResourceClient<AvailableEvent, AvailableEventResource, AvailableEventResponse>.PatchAsync(JsonApiDocument<AvailableEventResource>, CancellationToken)

SingletonResourceClient<AvailableEvent, AvailableEventResource, AvailableEventResponse>.DeleteAsync(CancellationToken)

ResourceClient<AvailableEvent>.AddQueryParameter(string, string)

ResourceClient<AvailableEvent>.ReplaceQueryParameter(string, string)

ResourceClient<AvailableEvent>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<AvailableEvent>.Uri

ResourceClient<AvailableEvent>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AvailableEventClient(HttpClient, Uri)

Client for interacting with the AvailableEvent resource.

public AvailableEventClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public AvailableEventClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

AvailableEventClient

The current AvailableEventClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public AvailableEventClient ClearParameters()

Returns

AvailableEventClient

The current AvailableEventClient instance.

GetAsync(CancellationToken)

Fetches the AvailableEvent resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AvailableEventResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.