Class DonorSummaryClient

Namespace

Crews.PlanningCenter.Api.Giving.V2019_10_18

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the DonorSummary resource.

public class DonorSummaryClient : SingletonResourceClient<DonorSummary, DonorSummaryResource, DonorSummaryResponse>

Inheritance

object

ResourceClient<DonorSummary>

SingletonResourceClient<DonorSummary, DonorSummaryResource, DonorSummaryResponse>

DonorSummaryClient

Inherited Members

SingletonResourceClient<DonorSummary, DonorSummaryResource, DonorSummaryResponse>.GetAsync(CancellationToken)

SingletonResourceClient<DonorSummary, DonorSummaryResource, DonorSummaryResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<DonorSummary, DonorSummaryResource, DonorSummaryResponse>.PatchAsync(DonorSummary, CancellationToken)

SingletonResourceClient<DonorSummary, DonorSummaryResource, DonorSummaryResponse>.PatchAsync(JsonApiDocument<DonorSummaryResource>, CancellationToken)

SingletonResourceClient<DonorSummary, DonorSummaryResource, DonorSummaryResponse>.DeleteAsync(CancellationToken)

ResourceClient<DonorSummary>.AddQueryParameter(string, string)

ResourceClient<DonorSummary>.ReplaceQueryParameter(string, string)

ResourceClient<DonorSummary>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<DonorSummary>.Uri

ResourceClient<DonorSummary>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

DonorSummaryClient(HttpClient, Uri)

Client for interacting with the DonorSummary resource.

public DonorSummaryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

JointGiver

Associated JointGiver.

public PersonClient JointGiver { get; }

Property Value

PersonClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public DonorSummaryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

DonorSummaryClient

The current DonorSummaryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public DonorSummaryClient ClearParameters()

Returns

DonorSummaryClient

The current DonorSummaryClient instance.

GetAsync(CancellationToken)

Fetches the DonorSummary resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<DonorSummaryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeJointGiver()

Include related JointGiver resources in the response.

public DonorSummaryClient IncludeJointGiver()

Returns

DonorSummaryClient