Class PaginatedResourceBookingClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2020_04_08

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ResourceBooking collection resources.

public class PaginatedResourceBookingClient : PaginatedResourceClient<ResourceBooking, ResourceBookingResource, ResourceBookingCollectionResponse, ResourceBookingResponse>

Inheritance

object

ResourceClient<ResourceBooking>

PaginatedResourceClient<ResourceBooking, ResourceBookingResource, ResourceBookingCollectionResponse, ResourceBookingResponse>

PaginatedResourceBookingClient

Inherited Members

PaginatedResourceClient<ResourceBooking, ResourceBookingResource, ResourceBookingCollectionResponse, ResourceBookingResponse>.PerPage(int)

PaginatedResourceClient<ResourceBooking, ResourceBookingResource, ResourceBookingCollectionResponse, ResourceBookingResponse>.Offset(int)

PaginatedResourceClient<ResourceBooking, ResourceBookingResource, ResourceBookingCollectionResponse, ResourceBookingResponse>.Filter(string)

PaginatedResourceClient<ResourceBooking, ResourceBookingResource, ResourceBookingCollectionResponse, ResourceBookingResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ResourceBooking, ResourceBookingResource, ResourceBookingCollectionResponse, ResourceBookingResponse>.PostAsync(ResourceBooking, CancellationToken)

PaginatedResourceClient<ResourceBooking, ResourceBookingResource, ResourceBookingCollectionResponse, ResourceBookingResponse>.PostAsync(JsonApiDocument<ResourceBookingResource>, 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

PaginatedResourceBookingClient(HttpClient, Uri)

Client for interacting with ResourceBooking collection resources.

public PaginatedResourceBookingClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedResourceBookingClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedResourceBookingClient

The current PaginatedResourceBookingClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedResourceBookingClient ClearParameters()

Returns

PaginatedResourceBookingClient

The current PaginatedResourceBookingClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedResourceBookingClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedResourceBookingClient

The current PaginatedResourceBookingClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

GetAsync(CancellationToken)

Fetches a paginated list of ResourceBooking resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceBookingCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of ResourceBooking resources.

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedResourceBookingClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedResourceBookingClient

The current PaginatedResourceBookingClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public ResourceBookingClient OrderByCreatedAt()

Returns

ResourceBookingClient

OrderByCreatedAtDescending()

Sort response items by the CreatedAt attribute. Use reverse order.

public ResourceBookingClient OrderByCreatedAtDescending()

Returns

ResourceBookingClient

OrderByEndsAt()

Sort response items by the EndsAt attribute.

public ResourceBookingClient OrderByEndsAt()

Returns

ResourceBookingClient

OrderByEndsAtDescending()

Sort response items by the EndsAt attribute. Use reverse order.

public ResourceBookingClient OrderByEndsAtDescending()

Returns

ResourceBookingClient

OrderByStartsAt()

Sort response items by the StartsAt attribute.

public ResourceBookingClient OrderByStartsAt()

Returns

ResourceBookingClient

OrderByStartsAtDescending()

Sort response items by the StartsAt attribute. Use reverse order.

public ResourceBookingClient OrderByStartsAtDescending()

Returns

ResourceBookingClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public ResourceBookingClient OrderByUpdatedAt()

Returns

ResourceBookingClient

OrderByUpdatedAtDescending()

Sort response items by the UpdatedAt attribute. Use reverse order.

public ResourceBookingClient OrderByUpdatedAtDescending()

Returns

ResourceBookingClient

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedResourceBookingClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedResourceBookingClient

The current PaginatedResourceBookingClient instance.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public ResourceBookingClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

ResourceBookingClient

WhereEndsAt(DateTime)

Query response items by the EndsAt attribute.

public ResourceBookingClient WhereEndsAt(DateTime value)

Parameters

value DateTime

Returns

ResourceBookingClient

WhereStartsAt(DateTime)

Query response items by the StartsAt attribute.

public ResourceBookingClient WhereStartsAt(DateTime value)

Parameters

value DateTime

Returns

ResourceBookingClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public ResourceBookingClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

ResourceBookingClient

WithId(string)

Creates a new instance of a ResourceBooking client for a specific resource ID.

public ResourceBookingClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ResourceBookingClient

A new instance of the resource client for the specified resource ID.