Class DesignationClient

Namespace

Crews.PlanningCenter.Api.Giving.V2019_10_18

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Designation resource.

public class DesignationClient : SingletonResourceClient<Designation, DesignationResource, DesignationResponse>

Inheritance

object

ResourceClient<Designation>

SingletonResourceClient<Designation, DesignationResource, DesignationResponse>

DesignationClient

Inherited Members

SingletonResourceClient<Designation, DesignationResource, DesignationResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Designation, DesignationResource, DesignationResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Designation, DesignationResource, DesignationResponse>.PatchAsync(Designation, CancellationToken)

SingletonResourceClient<Designation, DesignationResource, DesignationResponse>.PatchAsync(JsonApiDocument<DesignationResource>, CancellationToken)

SingletonResourceClient<Designation, DesignationResource, DesignationResponse>.DeleteAsync(CancellationToken)

ResourceClient<Designation>.AddQueryParameter(string, string)

ResourceClient<Designation>.ReplaceQueryParameter(string, string)

ResourceClient<Designation>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Designation>.Uri

ResourceClient<Designation>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

DesignationClient(HttpClient, Uri)

Client for interacting with the Designation resource.

public DesignationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Fund

Associated Fund.

public FundClient Fund { get; }

Property Value

FundClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public DesignationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

DesignationClient

The current DesignationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public DesignationClient ClearParameters()

Returns

DesignationClient

The current DesignationClient instance.

GetAsync(CancellationToken)

Fetches the Designation resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<DesignationResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.