Class LocationEventTimeClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the LocationEventTime resource.

public class LocationEventTimeClient : SingletonResourceClient<LocationEventTime, LocationEventTimeResource, LocationEventTimeResponse>

Inheritance

object

ResourceClient<LocationEventTime>

SingletonResourceClient<LocationEventTime, LocationEventTimeResource, LocationEventTimeResponse>

LocationEventTimeClient

Inherited Members

SingletonResourceClient<LocationEventTime, LocationEventTimeResource, LocationEventTimeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<LocationEventTime, LocationEventTimeResource, LocationEventTimeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<LocationEventTime, LocationEventTimeResource, LocationEventTimeResponse>.PatchAsync(LocationEventTime, CancellationToken)

SingletonResourceClient<LocationEventTime, LocationEventTimeResource, LocationEventTimeResponse>.PatchAsync(JsonApiDocument<LocationEventTimeResource>, CancellationToken)

SingletonResourceClient<LocationEventTime, LocationEventTimeResource, LocationEventTimeResponse>.DeleteAsync(CancellationToken)

ResourceClient<LocationEventTime>.AddQueryParameter(string, string)

ResourceClient<LocationEventTime>.ReplaceQueryParameter(string, string)

ResourceClient<LocationEventTime>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<LocationEventTime>.Uri

ResourceClient<LocationEventTime>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

LocationEventTimeClient(HttpClient, Uri)

Client for interacting with the LocationEventTime resource.

public LocationEventTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

CheckIns

Associated CheckIns.

public PaginatedCheckInClient CheckIns { get; }

Property Value

PaginatedCheckInClient

EventTime

Associated EventTime.

public EventTimeClient EventTime { get; }

Property Value

EventTimeClient

Location

Associated Location.

public LocationClient Location { get; }

Property Value

LocationClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public LocationEventTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

LocationEventTimeClient

The current LocationEventTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public LocationEventTimeClient ClearParameters()

Returns

LocationEventTimeClient

The current LocationEventTimeClient instance.

GetAsync(CancellationToken)

Fetches the LocationEventTime resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LocationEventTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEventTime()

Include related EventTime resources in the response.

public LocationEventTimeClient IncludeEventTime()

Returns

LocationEventTimeClient

IncludeLocation()

Include related Location resources in the response.

public LocationEventTimeClient IncludeLocation()

Returns

LocationEventTimeClient