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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedRecurringDonationDesignationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedRecurringDonationDesignationClient

The current PaginatedRecurringDonationDesignationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedRecurringDonationDesignationClient ClearParameters()

Returns

PaginatedRecurringDonationDesignationClient

The current PaginatedRecurringDonationDesignationClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedRecurringDonationDesignationClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedRecurringDonationDesignationClient

The current PaginatedRecurringDonationDesignationClient instance.

Remarks

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

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedRecurringDonationDesignationClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedRecurringDonationDesignationClient

The current PaginatedRecurringDonationDesignationClient instance.

PerPage(int)

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

public PaginatedRecurringDonationDesignationClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedRecurringDonationDesignationClient

The current PaginatedRecurringDonationDesignationClient instance.

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.