Class PaginatedPledgeCampaignClient

Namespace

Crews.PlanningCenter.Api.Giving.V2019_10_18

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PledgeCampaign collection resources.

public class PaginatedPledgeCampaignClient : PaginatedResourceClient<PledgeCampaign, PledgeCampaignResource, PledgeCampaignCollectionResponse, PledgeCampaignResponse>

Inheritance

object

ResourceClient<PledgeCampaign>

PaginatedResourceClient<PledgeCampaign, PledgeCampaignResource, PledgeCampaignCollectionResponse, PledgeCampaignResponse>

PaginatedPledgeCampaignClient

Inherited Members

PaginatedResourceClient<PledgeCampaign, PledgeCampaignResource, PledgeCampaignCollectionResponse, PledgeCampaignResponse>.PerPage(int)

PaginatedResourceClient<PledgeCampaign, PledgeCampaignResource, PledgeCampaignCollectionResponse, PledgeCampaignResponse>.Offset(int)

PaginatedResourceClient<PledgeCampaign, PledgeCampaignResource, PledgeCampaignCollectionResponse, PledgeCampaignResponse>.Filter(string)

PaginatedResourceClient<PledgeCampaign, PledgeCampaignResource, PledgeCampaignCollectionResponse, PledgeCampaignResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PledgeCampaign, PledgeCampaignResource, PledgeCampaignCollectionResponse, PledgeCampaignResponse>.PostAsync(PledgeCampaign, CancellationToken)

PaginatedResourceClient<PledgeCampaign, PledgeCampaignResource, PledgeCampaignCollectionResponse, PledgeCampaignResponse>.PostAsync(JsonApiDocument<PledgeCampaignResource>, CancellationToken)

ResourceClient<PledgeCampaign>.AddQueryParameter(string, string)

ResourceClient<PledgeCampaign>.ReplaceQueryParameter(string, string)

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

PaginatedPledgeCampaignClient(HttpClient, Uri)

Client for interacting with PledgeCampaign collection resources.

public PaginatedPledgeCampaignClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPledgeCampaignClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPledgeCampaignClient

The current PaginatedPledgeCampaignClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPledgeCampaignClient ClearParameters()

Returns

PaginatedPledgeCampaignClient

The current PaginatedPledgeCampaignClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPledgeCampaignClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPledgeCampaignClient

The current PaginatedPledgeCampaignClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of PledgeCampaign resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PledgeCampaignCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of PledgeCampaign resources.

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPledgeCampaignClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPledgeCampaignClient

The current PaginatedPledgeCampaignClient instance.

OrderByEndsAt()

Sort response items by the EndsAt attribute.

public PledgeCampaignClient OrderByEndsAt()

Returns

PledgeCampaignClient

OrderByEndsAtDescending()

Sort response items by the EndsAt attribute. Use reverse order.

public PledgeCampaignClient OrderByEndsAtDescending()

Returns

PledgeCampaignClient

OrderByStartsAt()

Sort response items by the StartsAt attribute.

public PledgeCampaignClient OrderByStartsAt()

Returns

PledgeCampaignClient

OrderByStartsAtDescending()

Sort response items by the StartsAt attribute. Use reverse order.

public PledgeCampaignClient OrderByStartsAtDescending()

Returns

PledgeCampaignClient

PerPage(int)

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

public PaginatedPledgeCampaignClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPledgeCampaignClient

The current PaginatedPledgeCampaignClient instance.

PostAsync(PledgeCampaign, CancellationToken)

Creates a new PledgeCampaign resource asynchronously.

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

Parameters

resource PledgeCampaign

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PledgeCampaignResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<PledgeCampaignResource>, CancellationToken)

Creates a new PledgeCampaign resource asynchronously.

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

Parameters

document JsonApiDocument<PledgeCampaignResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PledgeCampaignResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereEndsAt(DateTime)

Query response items by the EndsAt attribute.

public PledgeCampaignClient WhereEndsAt(DateTime value)

Parameters

value DateTime

Returns

PledgeCampaignClient

WhereFundId(int)

Query response items by the FundId attribute.

public PledgeCampaignClient WhereFundId(int value)

Parameters

value int

Returns

PledgeCampaignClient

WhereStartsAt(DateTime)

Query response items by the StartsAt attribute.

public PledgeCampaignClient WhereStartsAt(DateTime value)

Parameters

value DateTime

Returns

PledgeCampaignClient

WithId(string)

Creates a new instance of a PledgeCampaign client for a specific resource ID.

public PledgeCampaignClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PledgeCampaignClient

A new instance of the resource client for the specified resource ID.