Class PaginatedContainingResourceClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2020_04_08

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>.AddCustomParameter(string, string)

ResourceClient<ContainingResource>.ClearParameters()

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

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.

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.