Class PaginatedRecurringDonationClient

Namespace

Crews.PlanningCenter.Api.Giving.V2019_10_18

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with RecurringDonation collection resources.

public class PaginatedRecurringDonationClient : PaginatedResourceClient<RecurringDonation, RecurringDonationResource, RecurringDonationCollectionResponse, RecurringDonationResponse>

Inheritance

object

ResourceClient<RecurringDonation>

PaginatedResourceClient<RecurringDonation, RecurringDonationResource, RecurringDonationCollectionResponse, RecurringDonationResponse>

PaginatedRecurringDonationClient

Inherited Members

PaginatedResourceClient<RecurringDonation, RecurringDonationResource, RecurringDonationCollectionResponse, RecurringDonationResponse>.PerPage(int)

PaginatedResourceClient<RecurringDonation, RecurringDonationResource, RecurringDonationCollectionResponse, RecurringDonationResponse>.Offset(int)

PaginatedResourceClient<RecurringDonation, RecurringDonationResource, RecurringDonationCollectionResponse, RecurringDonationResponse>.Filter(string)

PaginatedResourceClient<RecurringDonation, RecurringDonationResource, RecurringDonationCollectionResponse, RecurringDonationResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<RecurringDonation, RecurringDonationResource, RecurringDonationCollectionResponse, RecurringDonationResponse>.PostAsync(RecurringDonation, CancellationToken)

PaginatedResourceClient<RecurringDonation, RecurringDonationResource, RecurringDonationCollectionResponse, RecurringDonationResponse>.PostAsync(JsonApiDocument<RecurringDonationResource>, CancellationToken)

ResourceClient<RecurringDonation>.AddQueryParameter(string, string)

ResourceClient<RecurringDonation>.ReplaceQueryParameter(string, string)

ResourceClient<RecurringDonation>.AddCustomParameter(string, string)

ResourceClient<RecurringDonation>.ClearParameters()

ResourceClient<RecurringDonation>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<RecurringDonation>.Uri

ResourceClient<RecurringDonation>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedRecurringDonationClient(HttpClient, Uri)

Client for interacting with RecurringDonation collection resources.

public PaginatedRecurringDonationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of RecurringDonation resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RecurringDonationCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeDesignations()

Include related Designations resources in the response.

public RecurringDonationClient IncludeDesignations()

Returns

RecurringDonationClient

WithId(string)

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

public RecurringDonationClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

RecurringDonationClient

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