Class LocationClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_09_03

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Location resource.

public class LocationClient : SingletonResourceClient<Location, LocationResource, LocationResponse>

Inheritance

object

ResourceClient<Location>

SingletonResourceClient<Location, LocationResource, LocationResponse>

LocationClient

Inherited Members

SingletonResourceClient<Location, LocationResource, LocationResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Location, LocationResource, LocationResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Location, LocationResource, LocationResponse>.PatchAsync(Location, CancellationToken)

SingletonResourceClient<Location, LocationResource, LocationResponse>.PatchAsync(JsonApiDocument<LocationResource>, CancellationToken)

SingletonResourceClient<Location, LocationResource, LocationResponse>.DeleteAsync(CancellationToken)

ResourceClient<Location>.AddQueryParameter(string, string)

ResourceClient<Location>.ReplaceQueryParameter(string, string)

ResourceClient<Location>.AddCustomParameter(string, string)

ResourceClient<Location>.ClearParameters()

ResourceClient<Location>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Location>.Uri

ResourceClient<Location>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

LocationClient(HttpClient, Uri)

Client for interacting with the Location resource.

public LocationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

CheckIns

Associated CheckIns.

public PaginatedCheckInClient CheckIns { get; }

Property Value

PaginatedCheckInClient

Event

Associated Event.

public EventClient Event { get; }

Property Value

EventClient

IntegrationLinks

Associated IntegrationLinks.

public PaginatedIntegrationLinkClient IntegrationLinks { get; }

Property Value

PaginatedIntegrationLinkClient

LocationEventPeriods

Associated LocationEventPeriods.

public PaginatedLocationEventPeriodClient LocationEventPeriods { get; }

Property Value

PaginatedLocationEventPeriodClient

LocationEventTimes

Associated LocationEventTimes.

public PaginatedLocationEventTimeClient LocationEventTimes { get; }

Property Value

PaginatedLocationEventTimeClient

LocationLabels

Associated LocationLabels.

public PaginatedLocationLabelClient LocationLabels { get; }

Property Value

PaginatedLocationLabelClient

Locations

Associated Locations.

public PaginatedLocationClient Locations { get; }

Property Value

PaginatedLocationClient

Options

Associated Options.

public PaginatedOptionClient Options { get; }

Property Value

PaginatedOptionClient

Parent

Associated Parent.

public LocationClient Parent { get; }

Property Value

LocationClient

Methods

GetAsync(CancellationToken)

Fetches the Location resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LocationResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEvent()

Include related Event resources in the response.

public LocationClient IncludeEvent()

Returns

LocationClient

IncludeLocations()

Include related Locations resources in the response.

public LocationClient IncludeLocations()

Returns

LocationClient

IncludeOptions()

Include related Options resources in the response.

public LocationClient IncludeOptions()

Returns

LocationClient

IncludeParent()

Include related Parent resources in the response.

public LocationClient IncludeParent()

Returns

LocationClient