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

ResourceClient<BatchGroup>.ClearParameters()

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

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

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

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.