Class InKindDonationClient

Namespace

Crews.PlanningCenter.Api.Giving.V2019_10_18

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the InKindDonation resource.

public class InKindDonationClient : SingletonResourceClient<InKindDonation, InKindDonationResource, InKindDonationResponse>

Inheritance

object

ResourceClient<InKindDonation>

SingletonResourceClient<InKindDonation, InKindDonationResource, InKindDonationResponse>

InKindDonationClient

Inherited Members

SingletonResourceClient<InKindDonation, InKindDonationResource, InKindDonationResponse>.GetAsync(CancellationToken)

SingletonResourceClient<InKindDonation, InKindDonationResource, InKindDonationResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<InKindDonation, InKindDonationResource, InKindDonationResponse>.PatchAsync(InKindDonation, CancellationToken)

SingletonResourceClient<InKindDonation, InKindDonationResource, InKindDonationResponse>.PatchAsync(JsonApiDocument<InKindDonationResource>, CancellationToken)

SingletonResourceClient<InKindDonation, InKindDonationResource, InKindDonationResponse>.DeleteAsync(CancellationToken)

ResourceClient<InKindDonation>.AddQueryParameter(string, string)

ResourceClient<InKindDonation>.ReplaceQueryParameter(string, string)

ResourceClient<InKindDonation>.AddCustomParameter(string, string)

ResourceClient<InKindDonation>.ClearParameters()

ResourceClient<InKindDonation>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<InKindDonation>.Uri

ResourceClient<InKindDonation>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

InKindDonationClient(HttpClient, Uri)

Client for interacting with the InKindDonation resource.

public InKindDonationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Campus

Associated Campus.

public PaginatedCampusClient Campus { get; }

Property Value

PaginatedCampusClient

Fund

Associated Fund.

public FundClient Fund { get; }

Property Value

FundClient

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Methods

DeleteAsync(CancellationToken)

Deletes the InKindDonation resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the InKindDonation resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<InKindDonationResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCampus()

Include related Campus resources in the response.

public InKindDonationClient IncludeCampus()

Returns

InKindDonationClient

IncludeFund()

Include related Fund resources in the response.

public InKindDonationClient IncludeFund()

Returns

InKindDonationClient

IncludePerson()

Include related Person resources in the response.

public InKindDonationClient IncludePerson()

Returns

InKindDonationClient

PatchAsync(InKindDonation, CancellationToken)

Updates an existing InKindDonation resource asynchronously.

public Task<InKindDonationResponse> PatchAsync(InKindDonation resource, CancellationToken cancellationToken = default)

Parameters

resource InKindDonation

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<InKindDonationResponse>

A task representing the asynchronous operation, containing the updated InKindDonation resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<InKindDonationResource>, CancellationToken)

Updates an existing InKindDonation resource asynchronously.

public Task<InKindDonationResponse> PatchAsync(JsonApiDocument<InKindDonationResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<InKindDonationResource>

The JSON:API document to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<InKindDonationResponse>

A task representing the asynchronous operation, containing the updated InKindDonation resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.