Class PaginatedStationClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_11_07

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>.AddCustomParameter(string, string)

ResourceClient<Station>.ClearParameters()

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

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

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.