Class RecurringDonationClient

Namespace

Crews.PlanningCenter.Api.Giving.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the RecurringDonation resource.

public class RecurringDonationClient : SingletonResourceClient<RecurringDonation, RecurringDonationResource, RecurringDonationResponse>

Inheritance

object

ResourceClient<RecurringDonation>

SingletonResourceClient<RecurringDonation, RecurringDonationResource, RecurringDonationResponse>

RecurringDonationClient

Inherited Members

SingletonResourceClient<RecurringDonation, RecurringDonationResource, RecurringDonationResponse>.GetAsync(CancellationToken)

SingletonResourceClient<RecurringDonation, RecurringDonationResource, RecurringDonationResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<RecurringDonation, RecurringDonationResource, RecurringDonationResponse>.PatchAsync(RecurringDonation, CancellationToken)

SingletonResourceClient<RecurringDonation, RecurringDonationResource, RecurringDonationResponse>.PatchAsync(JsonApiDocument<RecurringDonationResource>, CancellationToken)

SingletonResourceClient<RecurringDonation, RecurringDonationResource, RecurringDonationResponse>.DeleteAsync(CancellationToken)

ResourceClient<RecurringDonation>.AddQueryParameter(string, string)

ResourceClient<RecurringDonation>.ReplaceQueryParameter(string, string)

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

RecurringDonationClient(HttpClient, Uri)

Client for interacting with the RecurringDonation resource.

public RecurringDonationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Designations

Associated Designations.

public PaginatedRecurringDonationDesignationClient Designations { get; }

Property Value

PaginatedRecurringDonationDesignationClient

PaymentMethod

Associated PaymentMethod.

public PaymentMethodClient PaymentMethod { get; }

Property Value

PaymentMethodClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public RecurringDonationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

RecurringDonationClient

The current RecurringDonationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public RecurringDonationClient ClearParameters()

Returns

RecurringDonationClient

The current RecurringDonationClient instance.

GetAsync(CancellationToken)

Fetches the RecurringDonation resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RecurringDonationResponse>

A task representing the asynchronous operation, containing the RecurringDonation resource.

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