Class CampusClient

Namespace

Crews.PlanningCenter.Api.Giving.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Campus resource.

public class CampusClient : SingletonResourceClient<Campus, CampusResource, CampusResponse>

Inheritance

object

ResourceClient<Campus>

SingletonResourceClient<Campus, CampusResource, CampusResponse>

CampusClient

Inherited Members

SingletonResourceClient<Campus, CampusResource, CampusResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Campus, CampusResource, CampusResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Campus, CampusResource, CampusResponse>.PatchAsync(Campus, CancellationToken)

SingletonResourceClient<Campus, CampusResource, CampusResponse>.PatchAsync(JsonApiDocument<CampusResource>, CancellationToken)

SingletonResourceClient<Campus, CampusResource, CampusResponse>.DeleteAsync(CancellationToken)

ResourceClient<Campus>.AddQueryParameter(string, string)

ResourceClient<Campus>.ReplaceQueryParameter(string, string)

ResourceClient<Campus>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Campus>.Uri

ResourceClient<Campus>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

CampusClient(HttpClient, Uri)

Client for interacting with the Campus resource.

public CampusClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Donations

Associated Donations.

public PaginatedDonationClient Donations { get; }

Property Value

PaginatedDonationClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public CampusClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

CampusClient

The current CampusClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public CampusClient ClearParameters()

Returns

CampusClient

The current CampusClient instance.

GetAsync(CancellationToken)

Fetches the Campus resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CampusResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.