Class PaginatedBatchClient

Namespace

Crews.PlanningCenter.Api.Giving.V2019_10_18

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Batch collection resources.

public class PaginatedBatchClient : PaginatedResourceClient<Batch, BatchResource, BatchCollectionResponse, BatchResponse>

Inheritance

object

ResourceClient<Batch>

PaginatedResourceClient<Batch, BatchResource, BatchCollectionResponse, BatchResponse>

PaginatedBatchClient

Inherited Members

PaginatedResourceClient<Batch, BatchResource, BatchCollectionResponse, BatchResponse>.PerPage(int)

PaginatedResourceClient<Batch, BatchResource, BatchCollectionResponse, BatchResponse>.Offset(int)

PaginatedResourceClient<Batch, BatchResource, BatchCollectionResponse, BatchResponse>.Filter(string)

PaginatedResourceClient<Batch, BatchResource, BatchCollectionResponse, BatchResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Batch, BatchResource, BatchCollectionResponse, BatchResponse>.PostAsync(Batch, CancellationToken)

PaginatedResourceClient<Batch, BatchResource, BatchCollectionResponse, BatchResponse>.PostAsync(JsonApiDocument<BatchResource>, CancellationToken)

ResourceClient<Batch>.AddQueryParameter(string, string)

ResourceClient<Batch>.ReplaceQueryParameter(string, string)

ResourceClient<Batch>.AddCustomParameter(string, string)

ResourceClient<Batch>.ClearParameters()

ResourceClient<Batch>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Batch>.Uri

ResourceClient<Batch>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedBatchClient(HttpClient, Uri)

Client for interacting with Batch collection resources.

public PaginatedBatchClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Batch resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BatchCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeBatchGroup()

Include related BatchGroup resources in the response.

public BatchClient IncludeBatchGroup()

Returns

BatchClient

IncludeOwner()

Include related Owner resources in the response.

public BatchClient IncludeOwner()

Returns

BatchClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public BatchClient OrderByUpdatedAt()

Returns

BatchClient

OrderByUpdatedAtDescending()

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

public BatchClient OrderByUpdatedAtDescending()

Returns

BatchClient

PostAsync(Batch, CancellationToken)

Creates a new Batch resource asynchronously.

public Task<BatchResponse> PostAsync(Batch resource, CancellationToken cancellationToken = default)

Parameters

resource Batch

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BatchResponse>

A task representing the asynchronous operation, containing the created Batch resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<BatchResource>, CancellationToken)

Creates a new Batch resource asynchronously.

public Task<BatchResponse> PostAsync(JsonApiDocument<BatchResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<BatchResource>

The JSON:API document to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BatchResponse>

A task representing the asynchronous operation, containing the created Batch resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public BatchClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

BatchClient

WithId(string)

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

public BatchClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

BatchClient

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