Class FundClient

Namespace

Crews.PlanningCenter.Api.Giving.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Fund resource.

public class FundClient : SingletonResourceClient<Fund, FundResource, FundResponse>

Inheritance

object

ResourceClient<Fund>

SingletonResourceClient<Fund, FundResource, FundResponse>

FundClient

Inherited Members

SingletonResourceClient<Fund, FundResource, FundResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Fund, FundResource, FundResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Fund, FundResource, FundResponse>.PatchAsync(Fund, CancellationToken)

SingletonResourceClient<Fund, FundResource, FundResponse>.PatchAsync(JsonApiDocument<FundResource>, CancellationToken)

SingletonResourceClient<Fund, FundResource, FundResponse>.DeleteAsync(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

FundClient(HttpClient, Uri)

Client for interacting with the Fund resource.

public FundClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public FundClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

FundClient

The current FundClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public FundClient ClearParameters()

Returns

FundClient

The current FundClient instance.

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FundResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(Fund, CancellationToken)

Updates an existing Fund resource asynchronously.

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

Parameters

resource Fund

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FundResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<FundResource>, CancellationToken)

Updates an existing Fund resource asynchronously.

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

Parameters

document JsonApiDocument<FundResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FundResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.