Class PaginatedBatchGroupClient

Namespace

Crews.PlanningCenter.Api.Giving.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with BatchGroup collection resources.

public class PaginatedBatchGroupClient : PaginatedResourceClient<BatchGroup, BatchGroupResource, BatchGroupCollectionResponse, BatchGroupResponse>

Inheritance

object

ResourceClient<BatchGroup>

PaginatedResourceClient<BatchGroup, BatchGroupResource, BatchGroupCollectionResponse, BatchGroupResponse>

PaginatedBatchGroupClient

Inherited Members

PaginatedResourceClient<BatchGroup, BatchGroupResource, BatchGroupCollectionResponse, BatchGroupResponse>.PerPage(int)

PaginatedResourceClient<BatchGroup, BatchGroupResource, BatchGroupCollectionResponse, BatchGroupResponse>.Offset(int)

PaginatedResourceClient<BatchGroup, BatchGroupResource, BatchGroupCollectionResponse, BatchGroupResponse>.Filter(string)

PaginatedResourceClient<BatchGroup, BatchGroupResource, BatchGroupCollectionResponse, BatchGroupResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<BatchGroup, BatchGroupResource, BatchGroupCollectionResponse, BatchGroupResponse>.PostAsync(BatchGroup, CancellationToken)

PaginatedResourceClient<BatchGroup, BatchGroupResource, BatchGroupCollectionResponse, BatchGroupResponse>.PostAsync(JsonApiDocument<BatchGroupResource>, CancellationToken)

ResourceClient<BatchGroup>.AddQueryParameter(string, string)

ResourceClient<BatchGroup>.ReplaceQueryParameter(string, string)

ResourceClient<BatchGroup>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<BatchGroup>.Uri

ResourceClient<BatchGroup>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedBatchGroupClient(HttpClient, Uri)

Client for interacting with BatchGroup collection resources.

public PaginatedBatchGroupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedBatchGroupClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedBatchGroupClient

The current PaginatedBatchGroupClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedBatchGroupClient ClearParameters()

Returns

PaginatedBatchGroupClient

The current PaginatedBatchGroupClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedBatchGroupClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedBatchGroupClient

The current PaginatedBatchGroupClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of BatchGroup resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BatchGroupCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeOwner()

Include related Owner resources in the response.

public BatchGroupClient IncludeOwner()

Returns

BatchGroupClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedBatchGroupClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedBatchGroupClient

The current PaginatedBatchGroupClient instance.

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public BatchGroupClient OrderByUpdatedAt()

Returns

BatchGroupClient

OrderByUpdatedAtDescending()

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

public BatchGroupClient OrderByUpdatedAtDescending()

Returns

BatchGroupClient

PerPage(int)

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

public PaginatedBatchGroupClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedBatchGroupClient

The current PaginatedBatchGroupClient instance.

PostAsync(BatchGroup, CancellationToken)

Creates a new BatchGroup resource asynchronously.

public Task<BatchGroupResponse> PostAsync(BatchGroup resource, CancellationToken cancellationToken = default)

Parameters

resource BatchGroup

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BatchGroupResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<BatchGroupResource>, CancellationToken)

Creates a new BatchGroup resource asynchronously.

public Task<BatchGroupResponse> PostAsync(JsonApiDocument<BatchGroupResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<BatchGroupResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BatchGroupResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public BatchGroupClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

BatchGroupClient

WithId(string)

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

public BatchGroupClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

BatchGroupClient

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