Class StationClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2023_04_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Station resource.

public class StationClient : SingletonResourceClient<Station, StationResource, StationResponse>

Inheritance

object

ResourceClient<Station>

SingletonResourceClient<Station, StationResource, StationResponse>

StationClient

Inherited Members

SingletonResourceClient<Station, StationResource, StationResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Station, StationResource, StationResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Station, StationResource, StationResponse>.PatchAsync(Station, CancellationToken)

SingletonResourceClient<Station, StationResource, StationResponse>.PatchAsync(JsonApiDocument<StationResource>, CancellationToken)

SingletonResourceClient<Station, StationResource, StationResponse>.DeleteAsync(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

StationClient(HttpClient, Uri)

Client for interacting with the Station resource.

public StationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

CheckInGroups

Associated CheckInGroups.

public PaginatedCheckInGroupClient CheckInGroups { get; }

Property Value

PaginatedCheckInGroupClient

CheckedInAtCheckIns

Associated CheckedInAtCheckIns.

public PaginatedCheckInClient CheckedInAtCheckIns { get; }

Property Value

PaginatedCheckInClient

Event

Associated Event.

public EventClient Event { get; }

Property Value

EventClient

Location

Associated Location.

public LocationClient Location { get; }

Property Value

LocationClient

PrintStation

Associated PrintStation.

public StationClient PrintStation { get; }

Property Value

StationClient

Theme

Associated Theme.

public ThemeClient Theme { get; }

Property Value

ThemeClient

Methods

GetAsync(CancellationToken)

Fetches the Station resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<StationResponse>

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

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