Class EventPeriodClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the EventPeriod resource.

public class EventPeriodClient : SingletonResourceClient<EventPeriod, EventPeriodResource, EventPeriodResponse>

Inheritance

object

ResourceClient<EventPeriod>

SingletonResourceClient<EventPeriod, EventPeriodResource, EventPeriodResponse>

EventPeriodClient

Inherited Members

SingletonResourceClient<EventPeriod, EventPeriodResource, EventPeriodResponse>.GetAsync(CancellationToken)

SingletonResourceClient<EventPeriod, EventPeriodResource, EventPeriodResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<EventPeriod, EventPeriodResource, EventPeriodResponse>.PatchAsync(EventPeriod, CancellationToken)

SingletonResourceClient<EventPeriod, EventPeriodResource, EventPeriodResponse>.PatchAsync(JsonApiDocument<EventPeriodResource>, CancellationToken)

SingletonResourceClient<EventPeriod, EventPeriodResource, EventPeriodResponse>.DeleteAsync(CancellationToken)

ResourceClient<EventPeriod>.AddQueryParameter(string, string)

ResourceClient<EventPeriod>.ReplaceQueryParameter(string, string)

ResourceClient<EventPeriod>.AddCustomParameter(string, string)

ResourceClient<EventPeriod>.ClearParameters()

ResourceClient<EventPeriod>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EventPeriod>.Uri

ResourceClient<EventPeriod>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

EventPeriodClient(HttpClient, Uri)

Client for interacting with the EventPeriod resource.

public EventPeriodClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

CheckIns

Associated CheckIns.

public PaginatedCheckInClient CheckIns { get; }

Property Value

PaginatedCheckInClient

Event

Associated Event.

public EventClient Event { get; }

Property Value

EventClient

EventTimes

Associated EventTimes.

public PaginatedEventTimeClient EventTimes { get; }

Property Value

PaginatedEventTimeClient

LocationEventPeriods

Associated LocationEventPeriods.

public PaginatedLocationEventPeriodClient LocationEventPeriods { get; }

Property Value

PaginatedLocationEventPeriodClient

Methods

GetAsync(CancellationToken)

Fetches the EventPeriod resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventPeriodResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEvent()

Include related Event resources in the response.

public EventPeriodClient IncludeEvent()

Returns

EventPeriodClient

IncludeEventTimes()

Include related EventTimes resources in the response.

public EventPeriodClient IncludeEventTimes()

Returns

EventPeriodClient