Class LocationEventPeriodClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2023_04_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the LocationEventPeriod resource.

public class LocationEventPeriodClient : SingletonResourceClient<LocationEventPeriod, LocationEventPeriodResource, LocationEventPeriodResponse>

Inheritance

object

ResourceClient<LocationEventPeriod>

SingletonResourceClient<LocationEventPeriod, LocationEventPeriodResource, LocationEventPeriodResponse>

LocationEventPeriodClient

Inherited Members

SingletonResourceClient<LocationEventPeriod, LocationEventPeriodResource, LocationEventPeriodResponse>.GetAsync(CancellationToken)

SingletonResourceClient<LocationEventPeriod, LocationEventPeriodResource, LocationEventPeriodResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<LocationEventPeriod, LocationEventPeriodResource, LocationEventPeriodResponse>.PatchAsync(LocationEventPeriod, CancellationToken)

SingletonResourceClient<LocationEventPeriod, LocationEventPeriodResource, LocationEventPeriodResponse>.PatchAsync(JsonApiDocument<LocationEventPeriodResource>, CancellationToken)

SingletonResourceClient<LocationEventPeriod, LocationEventPeriodResource, LocationEventPeriodResponse>.DeleteAsync(CancellationToken)

ResourceClient<LocationEventPeriod>.AddQueryParameter(string, string)

ResourceClient<LocationEventPeriod>.ReplaceQueryParameter(string, string)

ResourceClient<LocationEventPeriod>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<LocationEventPeriod>.Uri

ResourceClient<LocationEventPeriod>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

LocationEventPeriodClient(HttpClient, Uri)

Client for interacting with the LocationEventPeriod resource.

public LocationEventPeriodClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

CheckIns

Associated CheckIns.

public PaginatedCheckInClient CheckIns { get; }

Property Value

PaginatedCheckInClient

EventPeriod

Associated EventPeriod.

public EventPeriodClient EventPeriod { get; }

Property Value

EventPeriodClient

Location

Associated Location.

public LocationClient Location { get; }

Property Value

LocationClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public LocationEventPeriodClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

LocationEventPeriodClient

The current LocationEventPeriodClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public LocationEventPeriodClient ClearParameters()

Returns

LocationEventPeriodClient

The current LocationEventPeriodClient instance.

GetAsync(CancellationToken)

Fetches the LocationEventPeriod resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LocationEventPeriodResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEventPeriod()

Include related EventPeriod resources in the response.

public LocationEventPeriodClient IncludeEventPeriod()

Returns

LocationEventPeriodClient

IncludeLocation()

Include related Location resources in the response.

public LocationEventPeriodClient IncludeLocation()

Returns

LocationEventPeriodClient