Class LocationClient

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

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>.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

Group

Associated Group.

public GroupClient Group { get; }

Property Value

GroupClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public LocationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

LocationClient

The current LocationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public LocationClient ClearParameters()

Returns

LocationClient

The current LocationClient instance.

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.

IncludeGroup()

Include related Group resources in the response.

public LocationClient IncludeGroup()

Returns

LocationClient