Class LocationLabelClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2023_04_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the LocationLabel resource.

public class LocationLabelClient : SingletonResourceClient<LocationLabel, LocationLabelResource, LocationLabelResponse>

Inheritance

object

ResourceClient<LocationLabel>

SingletonResourceClient<LocationLabel, LocationLabelResource, LocationLabelResponse>

LocationLabelClient

Inherited Members

SingletonResourceClient<LocationLabel, LocationLabelResource, LocationLabelResponse>.GetAsync(CancellationToken)

SingletonResourceClient<LocationLabel, LocationLabelResource, LocationLabelResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<LocationLabel, LocationLabelResource, LocationLabelResponse>.PatchAsync(LocationLabel, CancellationToken)

SingletonResourceClient<LocationLabel, LocationLabelResource, LocationLabelResponse>.PatchAsync(JsonApiDocument<LocationLabelResource>, CancellationToken)

SingletonResourceClient<LocationLabel, LocationLabelResource, LocationLabelResponse>.DeleteAsync(CancellationToken)

ResourceClient<LocationLabel>.AddQueryParameter(string, string)

ResourceClient<LocationLabel>.ReplaceQueryParameter(string, string)

ResourceClient<LocationLabel>.AddCustomParameter(string, string)

ResourceClient<LocationLabel>.ClearParameters()

ResourceClient<LocationLabel>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<LocationLabel>.Uri

ResourceClient<LocationLabel>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

LocationLabelClient(HttpClient, Uri)

Client for interacting with the LocationLabel resource.

public LocationLabelClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Label

Associated Label.

public LabelClient Label { get; }

Property Value

LabelClient

Location

Associated Location.

public LocationClient Location { get; }

Property Value

LocationClient

Methods

GetAsync(CancellationToken)

Fetches the LocationLabel resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LocationLabelResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeLabel()

Include related Label resources in the response.

public LocationLabelClient IncludeLabel()

Returns

LocationLabelClient

IncludeLocation()

Include related Location resources in the response.

public LocationLabelClient IncludeLocation()

Returns

LocationLabelClient