Class PaginatedFundClient

Namespace

Crews.PlanningCenter.Api.Giving.V2019_10_18

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Fund collection resources.

public class PaginatedFundClient : PaginatedResourceClient<Fund, FundResource, FundCollectionResponse, FundResponse>

Inheritance

object

ResourceClient<Fund>

PaginatedResourceClient<Fund, FundResource, FundCollectionResponse, FundResponse>

PaginatedFundClient

Inherited Members

PaginatedResourceClient<Fund, FundResource, FundCollectionResponse, FundResponse>.PerPage(int)

PaginatedResourceClient<Fund, FundResource, FundCollectionResponse, FundResponse>.Offset(int)

PaginatedResourceClient<Fund, FundResource, FundCollectionResponse, FundResponse>.Filter(string)

PaginatedResourceClient<Fund, FundResource, FundCollectionResponse, FundResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Fund, FundResource, FundCollectionResponse, FundResponse>.PostAsync(Fund, CancellationToken)

PaginatedResourceClient<Fund, FundResource, FundCollectionResponse, FundResponse>.PostAsync(JsonApiDocument<FundResource>, CancellationToken)

ResourceClient<Fund>.AddQueryParameter(string, string)

ResourceClient<Fund>.ReplaceQueryParameter(string, string)

ResourceClient<Fund>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Fund>.Uri

ResourceClient<Fund>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedFundClient(HttpClient, Uri)

Client for interacting with Fund collection resources.

public PaginatedFundClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedFundClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedFundClient

The current PaginatedFundClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedFundClient ClearParameters()

Returns

PaginatedFundClient

The current PaginatedFundClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedFundClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedFundClient

The current PaginatedFundClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Fund resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FundCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedFundClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedFundClient

The current PaginatedFundClient instance.

PerPage(int)

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

public PaginatedFundClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedFundClient

The current PaginatedFundClient instance.

PostAsync(Fund, CancellationToken)

Creates a new Fund resource asynchronously.

public Task<FundResponse> PostAsync(Fund resource, CancellationToken cancellationToken = default)

Parameters

resource Fund

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FundResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<FundResource>, CancellationToken)

Creates a new Fund resource asynchronously.

public Task<FundResponse> PostAsync(JsonApiDocument<FundResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<FundResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FundResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereDefault(bool)

Query response items by the Default attribute.

public FundClient WhereDefault(bool value)

Parameters

value bool

Returns

FundClient

WhereId(string)

Query response items by the Id attribute.

public FundClient WhereId(string value)

Parameters

value string

Returns

FundClient

WhereName(string)

Query response items by the Name attribute.

public FundClient WhereName(string value)

Parameters

value string

Returns

FundClient

WhereVisibility(string)

Query response items by the Visibility attribute.

public FundClient WhereVisibility(string value)

Parameters

value string

Returns

FundClient

WithId(string)

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

public FundClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

FundClient

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