Class PaginatedRecurringDonationDesignationClient

Namespace

Crews.PlanningCenter.Api.Giving.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with RecurringDonationDesignation collection resources.

public class PaginatedRecurringDonationDesignationClient : PaginatedResourceClient<RecurringDonationDesignation, RecurringDonationDesignationResource, RecurringDonationDesignationCollectionResponse, RecurringDonationDesignationResponse>

Inheritance

object

ResourceClient<RecurringDonationDesignation>

PaginatedResourceClient<RecurringDonationDesignation, RecurringDonationDesignationResource, RecurringDonationDesignationCollectionResponse, RecurringDonationDesignationResponse>

PaginatedRecurringDonationDesignationClient

Inherited Members

PaginatedResourceClient<RecurringDonationDesignation, RecurringDonationDesignationResource, RecurringDonationDesignationCollectionResponse, RecurringDonationDesignationResponse>.PerPage(int)

PaginatedResourceClient<RecurringDonationDesignation, RecurringDonationDesignationResource, RecurringDonationDesignationCollectionResponse, RecurringDonationDesignationResponse>.Offset(int)

PaginatedResourceClient<RecurringDonationDesignation, RecurringDonationDesignationResource, RecurringDonationDesignationCollectionResponse, RecurringDonationDesignationResponse>.Filter(string)

PaginatedResourceClient<RecurringDonationDesignation, RecurringDonationDesignationResource, RecurringDonationDesignationCollectionResponse, RecurringDonationDesignationResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<RecurringDonationDesignation, RecurringDonationDesignationResource, RecurringDonationDesignationCollectionResponse, RecurringDonationDesignationResponse>.PostAsync(RecurringDonationDesignation, CancellationToken)

PaginatedResourceClient<RecurringDonationDesignation, RecurringDonationDesignationResource, RecurringDonationDesignationCollectionResponse, RecurringDonationDesignationResponse>.PostAsync(JsonApiDocument<RecurringDonationDesignationResource>, CancellationToken)

ResourceClient<RecurringDonationDesignation>.AddQueryParameter(string, string)

ResourceClient<RecurringDonationDesignation>.ReplaceQueryParameter(string, string)

ResourceClient<RecurringDonationDesignation>.AddCustomParameter(string, string)

ResourceClient<RecurringDonationDesignation>.ClearParameters()

ResourceClient<RecurringDonationDesignation>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<RecurringDonationDesignation>.Uri

ResourceClient<RecurringDonationDesignation>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedRecurringDonationDesignationClient(HttpClient, Uri)

Client for interacting with RecurringDonationDesignation collection resources.

public PaginatedRecurringDonationDesignationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of RecurringDonationDesignation resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RecurringDonationDesignationCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeFund()

Include related Fund resources in the response.

public RecurringDonationDesignationClient IncludeFund()

Returns

RecurringDonationDesignationClient

WithId(string)

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

public RecurringDonationDesignationClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

RecurringDonationDesignationClient

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