Class PaginatedContainingResourceClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2022_07_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ContainingResource collection resources.

public class PaginatedContainingResourceClient : PaginatedResourceClient<ContainingResource, ContainingResourceResource, ContainingResourceCollectionResponse, ContainingResourceResponse>

Inheritance

object

ResourceClient<ContainingResource>

PaginatedResourceClient<ContainingResource, ContainingResourceResource, ContainingResourceCollectionResponse, ContainingResourceResponse>

PaginatedContainingResourceClient

Inherited Members

PaginatedResourceClient<ContainingResource, ContainingResourceResource, ContainingResourceCollectionResponse, ContainingResourceResponse>.PerPage(int)

PaginatedResourceClient<ContainingResource, ContainingResourceResource, ContainingResourceCollectionResponse, ContainingResourceResponse>.Offset(int)

PaginatedResourceClient<ContainingResource, ContainingResourceResource, ContainingResourceCollectionResponse, ContainingResourceResponse>.Filter(string)

PaginatedResourceClient<ContainingResource, ContainingResourceResource, ContainingResourceCollectionResponse, ContainingResourceResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ContainingResource, ContainingResourceResource, ContainingResourceCollectionResponse, ContainingResourceResponse>.PostAsync(ContainingResource, CancellationToken)

PaginatedResourceClient<ContainingResource, ContainingResourceResource, ContainingResourceCollectionResponse, ContainingResourceResponse>.PostAsync(JsonApiDocument<ContainingResourceResource>, CancellationToken)

ResourceClient<ContainingResource>.AddQueryParameter(string, string)

ResourceClient<ContainingResource>.ReplaceQueryParameter(string, string)

ResourceClient<ContainingResource>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ContainingResource>.Uri

ResourceClient<ContainingResource>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedContainingResourceClient(HttpClient, Uri)

Client for interacting with ContainingResource collection resources.

public PaginatedContainingResourceClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedContainingResourceClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedContainingResourceClient

The current PaginatedContainingResourceClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedContainingResourceClient ClearParameters()

Returns

PaginatedContainingResourceClient

The current PaginatedContainingResourceClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedContainingResourceClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedContainingResourceClient

The current PaginatedContainingResourceClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of ContainingResource resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ContainingResourceCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedContainingResourceClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedContainingResourceClient

The current PaginatedContainingResourceClient instance.

PerPage(int)

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

public PaginatedContainingResourceClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedContainingResourceClient

The current PaginatedContainingResourceClient instance.

WithId(string)

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

public ContainingResourceClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ContainingResourceClient

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