Class PaginatedLocationEventPeriodClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with LocationEventPeriod collection resources.

public class PaginatedLocationEventPeriodClient : PaginatedResourceClient<LocationEventPeriod, LocationEventPeriodResource, LocationEventPeriodCollectionResponse, LocationEventPeriodResponse>

Inheritance

object

ResourceClient<LocationEventPeriod>

PaginatedResourceClient<LocationEventPeriod, LocationEventPeriodResource, LocationEventPeriodCollectionResponse, LocationEventPeriodResponse>

PaginatedLocationEventPeriodClient

Inherited Members

PaginatedResourceClient<LocationEventPeriod, LocationEventPeriodResource, LocationEventPeriodCollectionResponse, LocationEventPeriodResponse>.PerPage(int)

PaginatedResourceClient<LocationEventPeriod, LocationEventPeriodResource, LocationEventPeriodCollectionResponse, LocationEventPeriodResponse>.Offset(int)

PaginatedResourceClient<LocationEventPeriod, LocationEventPeriodResource, LocationEventPeriodCollectionResponse, LocationEventPeriodResponse>.Filter(string)

PaginatedResourceClient<LocationEventPeriod, LocationEventPeriodResource, LocationEventPeriodCollectionResponse, LocationEventPeriodResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<LocationEventPeriod, LocationEventPeriodResource, LocationEventPeriodCollectionResponse, LocationEventPeriodResponse>.PostAsync(LocationEventPeriod, CancellationToken)

PaginatedResourceClient<LocationEventPeriod, LocationEventPeriodResource, LocationEventPeriodCollectionResponse, LocationEventPeriodResponse>.PostAsync(JsonApiDocument<LocationEventPeriodResource>, 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

PaginatedLocationEventPeriodClient(HttpClient, Uri)

Client for interacting with LocationEventPeriod collection resources.

public PaginatedLocationEventPeriodClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedLocationEventPeriodClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedLocationEventPeriodClient

The current PaginatedLocationEventPeriodClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedLocationEventPeriodClient ClearParameters()

Returns

PaginatedLocationEventPeriodClient

The current PaginatedLocationEventPeriodClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedLocationEventPeriodClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedLocationEventPeriodClient

The current PaginatedLocationEventPeriodClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of LocationEventPeriod resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LocationEventPeriodCollectionResponse>

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

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedLocationEventPeriodClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedLocationEventPeriodClient

The current PaginatedLocationEventPeriodClient instance.

PerPage(int)

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

public PaginatedLocationEventPeriodClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedLocationEventPeriodClient

The current PaginatedLocationEventPeriodClient instance.

WithId(string)

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

public LocationEventPeriodClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

LocationEventPeriodClient

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