Class PledgeCampaignClient

Namespace

Crews.PlanningCenter.Api.Giving.V2019_10_18

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PledgeCampaign resource.

public class PledgeCampaignClient : SingletonResourceClient<PledgeCampaign, PledgeCampaignResource, PledgeCampaignResponse>

Inheritance

object

ResourceClient<PledgeCampaign>

SingletonResourceClient<PledgeCampaign, PledgeCampaignResource, PledgeCampaignResponse>

PledgeCampaignClient

Inherited Members

SingletonResourceClient<PledgeCampaign, PledgeCampaignResource, PledgeCampaignResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PledgeCampaign, PledgeCampaignResource, PledgeCampaignResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PledgeCampaign, PledgeCampaignResource, PledgeCampaignResponse>.PatchAsync(PledgeCampaign, CancellationToken)

SingletonResourceClient<PledgeCampaign, PledgeCampaignResource, PledgeCampaignResponse>.PatchAsync(JsonApiDocument<PledgeCampaignResource>, CancellationToken)

SingletonResourceClient<PledgeCampaign, PledgeCampaignResource, PledgeCampaignResponse>.DeleteAsync(CancellationToken)

ResourceClient<PledgeCampaign>.AddQueryParameter(string, string)

ResourceClient<PledgeCampaign>.ReplaceQueryParameter(string, string)

ResourceClient<PledgeCampaign>.AddCustomParameter(string, string)

ResourceClient<PledgeCampaign>.ClearParameters()

ResourceClient<PledgeCampaign>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PledgeCampaign>.Uri

ResourceClient<PledgeCampaign>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PledgeCampaignClient(HttpClient, Uri)

Client for interacting with the PledgeCampaign resource.

public PledgeCampaignClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Fund

Associated Fund.

public FundClient Fund { get; }

Property Value

FundClient

Pledges

Associated Pledges.

public PaginatedPledgeClient Pledges { get; }

Property Value

PaginatedPledgeClient

Methods

DeleteAsync(CancellationToken)

Deletes the PledgeCampaign 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 PledgeCampaign resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PledgeCampaignResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeFund()

Include related Fund resources in the response.

public PledgeCampaignClient IncludeFund()

Returns

PledgeCampaignClient

PatchAsync(PledgeCampaign, CancellationToken)

Updates an existing PledgeCampaign resource asynchronously.

public Task<PledgeCampaignResponse> PatchAsync(PledgeCampaign resource, CancellationToken cancellationToken = default)

Parameters

resource PledgeCampaign

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PledgeCampaignResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<PledgeCampaignResource>, CancellationToken)

Updates an existing PledgeCampaign resource asynchronously.

public Task<PledgeCampaignResponse> PatchAsync(JsonApiDocument<PledgeCampaignResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<PledgeCampaignResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PledgeCampaignResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.