Class PaginatedStationClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_09_03

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Station collection resources.

public class PaginatedStationClient : PaginatedResourceClient<Station, StationResource, StationCollectionResponse, StationResponse>

Inheritance

object

ResourceClient<Station>

PaginatedResourceClient<Station, StationResource, StationCollectionResponse, StationResponse>

PaginatedStationClient

Inherited Members

PaginatedResourceClient<Station, StationResource, StationCollectionResponse, StationResponse>.PerPage(int)

PaginatedResourceClient<Station, StationResource, StationCollectionResponse, StationResponse>.Offset(int)

PaginatedResourceClient<Station, StationResource, StationCollectionResponse, StationResponse>.Filter(string)

PaginatedResourceClient<Station, StationResource, StationCollectionResponse, StationResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Station, StationResource, StationCollectionResponse, StationResponse>.PostAsync(Station, CancellationToken)

PaginatedResourceClient<Station, StationResource, StationCollectionResponse, StationResponse>.PostAsync(JsonApiDocument<StationResource>, CancellationToken)

ResourceClient<Station>.AddQueryParameter(string, string)

ResourceClient<Station>.ReplaceQueryParameter(string, string)

ResourceClient<Station>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Station>.Uri

ResourceClient<Station>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedStationClient(HttpClient, Uri)

Client for interacting with Station collection resources.

public PaginatedStationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedStationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedStationClient

The current PaginatedStationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedStationClient ClearParameters()

Returns

PaginatedStationClient

The current PaginatedStationClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedStationClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedStationClient

The current PaginatedStationClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Station resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<StationCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEvent()

Include related Event resources in the response.

public StationClient IncludeEvent()

Returns

StationClient

IncludeLocation()

Include related Location resources in the response.

public StationClient IncludeLocation()

Returns

StationClient

IncludePrintStation()

Include related PrintStation resources in the response.

public StationClient IncludePrintStation()

Returns

StationClient

IncludeTheme()

Include related Theme resources in the response.

public StationClient IncludeTheme()

Returns

StationClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedStationClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedStationClient

The current PaginatedStationClient instance.

PerPage(int)

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

public PaginatedStationClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedStationClient

The current PaginatedStationClient instance.

WithId(string)

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

public StationClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

StationClient

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