Class ResourceBookingClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ResourceBooking resource.

public class ResourceBookingClient : SingletonResourceClient<ResourceBooking, ResourceBookingResource, ResourceBookingResponse>

Inheritance

object

ResourceClient<ResourceBooking>

SingletonResourceClient<ResourceBooking, ResourceBookingResource, ResourceBookingResponse>

ResourceBookingClient

Inherited Members

SingletonResourceClient<ResourceBooking, ResourceBookingResource, ResourceBookingResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ResourceBooking, ResourceBookingResource, ResourceBookingResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ResourceBooking, ResourceBookingResource, ResourceBookingResponse>.PatchAsync(ResourceBooking, CancellationToken)

SingletonResourceClient<ResourceBooking, ResourceBookingResource, ResourceBookingResponse>.PatchAsync(JsonApiDocument<ResourceBookingResource>, CancellationToken)

SingletonResourceClient<ResourceBooking, ResourceBookingResource, ResourceBookingResponse>.DeleteAsync(CancellationToken)

ResourceClient<ResourceBooking>.AddQueryParameter(string, string)

ResourceClient<ResourceBooking>.ReplaceQueryParameter(string, string)

ResourceClient<ResourceBooking>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ResourceBooking>.Uri

ResourceClient<ResourceBooking>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ResourceBookingClient(HttpClient, Uri)

Client for interacting with the ResourceBooking resource.

public ResourceBookingClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

EventInstance

Associated EventInstance.

public EventInstanceClient EventInstance { get; }

Property Value

EventInstanceClient

EventResourceRequest

Associated EventResourceRequest.

public EventResourceRequestClient EventResourceRequest { get; }

Property Value

EventResourceRequestClient

Resource

Associated Resource.

public ResourceClient Resource { get; }

Property Value

ResourceClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ResourceBookingClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ResourceBookingClient

The current ResourceBookingClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ResourceBookingClient ClearParameters()

Returns

ResourceBookingClient

The current ResourceBookingClient instance.

GetAsync(CancellationToken)

Fetches the ResourceBooking resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceBookingResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEventInstance()

Include related EventInstance resources in the response.

public ResourceBookingClient IncludeEventInstance()

Returns

ResourceBookingClient

IncludeEventResourceRequest()

Include related EventResourceRequest resources in the response.

public ResourceBookingClient IncludeEventResourceRequest()

Returns

ResourceBookingClient

IncludeResource()

Include related Resource resources in the response.

public ResourceBookingClient IncludeResource()

Returns

ResourceBookingClient