Class PaginatedEventResourceRequestClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2022_07_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with EventResourceRequest collection resources.

public class PaginatedEventResourceRequestClient : PaginatedResourceClient<EventResourceRequest, EventResourceRequestResource, EventResourceRequestCollectionResponse, EventResourceRequestResponse>

Inheritance

object

ResourceClient<EventResourceRequest>

PaginatedResourceClient<EventResourceRequest, EventResourceRequestResource, EventResourceRequestCollectionResponse, EventResourceRequestResponse>

PaginatedEventResourceRequestClient

Inherited Members

PaginatedResourceClient<EventResourceRequest, EventResourceRequestResource, EventResourceRequestCollectionResponse, EventResourceRequestResponse>.PerPage(int)

PaginatedResourceClient<EventResourceRequest, EventResourceRequestResource, EventResourceRequestCollectionResponse, EventResourceRequestResponse>.Offset(int)

PaginatedResourceClient<EventResourceRequest, EventResourceRequestResource, EventResourceRequestCollectionResponse, EventResourceRequestResponse>.Filter(string)

PaginatedResourceClient<EventResourceRequest, EventResourceRequestResource, EventResourceRequestCollectionResponse, EventResourceRequestResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<EventResourceRequest, EventResourceRequestResource, EventResourceRequestCollectionResponse, EventResourceRequestResponse>.PostAsync(EventResourceRequest, CancellationToken)

PaginatedResourceClient<EventResourceRequest, EventResourceRequestResource, EventResourceRequestCollectionResponse, EventResourceRequestResponse>.PostAsync(JsonApiDocument<EventResourceRequestResource>, CancellationToken)

ResourceClient<EventResourceRequest>.AddQueryParameter(string, string)

ResourceClient<EventResourceRequest>.ReplaceQueryParameter(string, string)

ResourceClient<EventResourceRequest>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EventResourceRequest>.Uri

ResourceClient<EventResourceRequest>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedEventResourceRequestClient(HttpClient, Uri)

Client for interacting with EventResourceRequest collection resources.

public PaginatedEventResourceRequestClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedEventResourceRequestClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedEventResourceRequestClient

The current PaginatedEventResourceRequestClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedEventResourceRequestClient ClearParameters()

Returns

PaginatedEventResourceRequestClient

The current PaginatedEventResourceRequestClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedEventResourceRequestClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedEventResourceRequestClient

The current PaginatedEventResourceRequestClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of EventResourceRequest resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventResourceRequestCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCreatedBy()

Include related CreatedBy resources in the response.

public EventResourceRequestClient IncludeCreatedBy()

Returns

EventResourceRequestClient

IncludeEvent()

Include related Event resources in the response.

public EventResourceRequestClient IncludeEvent()

Returns

EventResourceRequestClient

IncludeResource()

Include related Resource resources in the response.

public EventResourceRequestClient IncludeResource()

Returns

EventResourceRequestClient

IncludeRoomSetup()

Include related RoomSetup resources in the response.

public EventResourceRequestClient IncludeRoomSetup()

Returns

EventResourceRequestClient

IncludeUpdatedBy()

Include related UpdatedBy resources in the response.

public EventResourceRequestClient IncludeUpdatedBy()

Returns

EventResourceRequestClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedEventResourceRequestClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedEventResourceRequestClient

The current PaginatedEventResourceRequestClient instance.

PerPage(int)

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

public PaginatedEventResourceRequestClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedEventResourceRequestClient

The current PaginatedEventResourceRequestClient instance.

WhereApprovalSent(bool)

Query response items by the ApprovalSent attribute.

public EventResourceRequestClient WhereApprovalSent(bool value)

Parameters

value bool

Returns

EventResourceRequestClient

WhereApprovalStatus(string)

Query response items by the ApprovalStatus attribute.

public EventResourceRequestClient WhereApprovalStatus(string value)

Parameters

value string

Returns

EventResourceRequestClient

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public EventResourceRequestClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

EventResourceRequestClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public EventResourceRequestClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

EventResourceRequestClient

WithId(string)

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

public EventResourceRequestClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EventResourceRequestClient

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