Class PaginatedLocationEventTimeClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_11_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with LocationEventTime collection resources.

public class PaginatedLocationEventTimeClient : PaginatedResourceClient<LocationEventTime, LocationEventTimeResource, LocationEventTimeCollectionResponse, LocationEventTimeResponse>

Inheritance

object

ResourceClient<LocationEventTime>

PaginatedResourceClient<LocationEventTime, LocationEventTimeResource, LocationEventTimeCollectionResponse, LocationEventTimeResponse>

PaginatedLocationEventTimeClient

Inherited Members

PaginatedResourceClient<LocationEventTime, LocationEventTimeResource, LocationEventTimeCollectionResponse, LocationEventTimeResponse>.PerPage(int)

PaginatedResourceClient<LocationEventTime, LocationEventTimeResource, LocationEventTimeCollectionResponse, LocationEventTimeResponse>.Offset(int)

PaginatedResourceClient<LocationEventTime, LocationEventTimeResource, LocationEventTimeCollectionResponse, LocationEventTimeResponse>.Filter(string)

PaginatedResourceClient<LocationEventTime, LocationEventTimeResource, LocationEventTimeCollectionResponse, LocationEventTimeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<LocationEventTime, LocationEventTimeResource, LocationEventTimeCollectionResponse, LocationEventTimeResponse>.PostAsync(LocationEventTime, CancellationToken)

PaginatedResourceClient<LocationEventTime, LocationEventTimeResource, LocationEventTimeCollectionResponse, LocationEventTimeResponse>.PostAsync(JsonApiDocument<LocationEventTimeResource>, 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

PaginatedLocationEventTimeClient(HttpClient, Uri)

Client for interacting with LocationEventTime collection resources.

public PaginatedLocationEventTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedLocationEventTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedLocationEventTimeClient

The current PaginatedLocationEventTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedLocationEventTimeClient ClearParameters()

Returns

PaginatedLocationEventTimeClient

The current PaginatedLocationEventTimeClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedLocationEventTimeClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedLocationEventTimeClient

The current PaginatedLocationEventTimeClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

GetAsync(CancellationToken)

Fetches a paginated list of LocationEventTime resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LocationEventTimeCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of LocationEventTime resources.

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedLocationEventTimeClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedLocationEventTimeClient

The current PaginatedLocationEventTimeClient instance.

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedLocationEventTimeClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedLocationEventTimeClient

The current PaginatedLocationEventTimeClient instance.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public LocationEventTimeClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

LocationEventTimeClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public LocationEventTimeClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

LocationEventTimeClient

WithId(string)

Creates a new instance of a LocationEventTime client for a specific resource ID.

public LocationEventTimeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

LocationEventTimeClient

A new instance of the resource client for the specified resource ID.