Class CalendarClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2020_04_08

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Calendar resource.

public class CalendarClient : SingletonResourceClient<Calendar, CalendarResource, CalendarResponse>

Inheritance

object

ResourceClient<Calendar>

SingletonResourceClient<Calendar, CalendarResource, CalendarResponse>

CalendarClient

Inherited Members

SingletonResourceClient<Calendar, CalendarResource, CalendarResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Calendar, CalendarResource, CalendarResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Calendar, CalendarResource, CalendarResponse>.PatchAsync(Calendar, CancellationToken)

SingletonResourceClient<Calendar, CalendarResource, CalendarResponse>.PatchAsync(JsonApiDocument<CalendarResource>, CancellationToken)

SingletonResourceClient<Calendar, CalendarResource, CalendarResponse>.DeleteAsync(CancellationToken)

ResourceClient<Calendar>.AddQueryParameter(string, string)

ResourceClient<Calendar>.ReplaceQueryParameter(string, string)

ResourceClient<Calendar>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Calendar>.Uri

ResourceClient<Calendar>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

CalendarClient(HttpClient, Uri)

Client for interacting with the Calendar resource.

public CalendarClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

ApprovalGroups

Associated ApprovalGroups.

public PaginatedResourceApprovalGroupClient ApprovalGroups { get; }

Property Value

PaginatedResourceApprovalGroupClient

Events

Associated Events.

public PaginatedEventClient Events { get; }

Property Value

PaginatedEventClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public CalendarClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

CalendarClient

The current CalendarClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public CalendarClient ClearParameters()

Returns

CalendarClient

The current CalendarClient instance.

GetAsync(CancellationToken)

Fetches the Calendar resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CalendarResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeApprovalGroups()

Include related ApprovalGroups resources in the response.

public CalendarClient IncludeApprovalGroups()

Returns

CalendarClient