Class PlanPersonTimeClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PlanPersonTime resource.

public class PlanPersonTimeClient : SingletonResourceClient<PlanPersonTime, PlanPersonTimeResource, PlanPersonTimeResponse>

Inheritance

object

ResourceClient<PlanPersonTime>

SingletonResourceClient<PlanPersonTime, PlanPersonTimeResource, PlanPersonTimeResponse>

PlanPersonTimeClient

Inherited Members

SingletonResourceClient<PlanPersonTime, PlanPersonTimeResource, PlanPersonTimeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PlanPersonTime, PlanPersonTimeResource, PlanPersonTimeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PlanPersonTime, PlanPersonTimeResource, PlanPersonTimeResponse>.PatchAsync(PlanPersonTime, CancellationToken)

SingletonResourceClient<PlanPersonTime, PlanPersonTimeResource, PlanPersonTimeResponse>.PatchAsync(JsonApiDocument<PlanPersonTimeResource>, CancellationToken)

SingletonResourceClient<PlanPersonTime, PlanPersonTimeResource, PlanPersonTimeResponse>.DeleteAsync(CancellationToken)

ResourceClient<PlanPersonTime>.AddQueryParameter(string, string)

ResourceClient<PlanPersonTime>.ReplaceQueryParameter(string, string)

ResourceClient<PlanPersonTime>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PlanPersonTime>.Uri

ResourceClient<PlanPersonTime>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PlanPersonTimeClient(HttpClient, Uri)

Client for interacting with the PlanPersonTime resource.

public PlanPersonTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PlanPersonTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PlanPersonTimeClient

The current PlanPersonTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PlanPersonTimeClient ClearParameters()

Returns

PlanPersonTimeClient

The current PlanPersonTimeClient instance.

GetAsync(CancellationToken)

Fetches the PlanPersonTime resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanPersonTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.