Class PlanPersonClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PlanPerson resource.

public class PlanPersonClient : SingletonResourceClient<PlanPerson, PlanPersonResource, PlanPersonResponse>

Inheritance

object

ResourceClient<PlanPerson>

SingletonResourceClient<PlanPerson, PlanPersonResource, PlanPersonResponse>

PlanPersonClient

Inherited Members

SingletonResourceClient<PlanPerson, PlanPersonResource, PlanPersonResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PlanPerson, PlanPersonResource, PlanPersonResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PlanPerson, PlanPersonResource, PlanPersonResponse>.PatchAsync(PlanPerson, CancellationToken)

SingletonResourceClient<PlanPerson, PlanPersonResource, PlanPersonResponse>.PatchAsync(JsonApiDocument<PlanPersonResource>, CancellationToken)

SingletonResourceClient<PlanPerson, PlanPersonResource, PlanPersonResponse>.DeleteAsync(CancellationToken)

ResourceClient<PlanPerson>.AddQueryParameter(string, string)

ResourceClient<PlanPerson>.ReplaceQueryParameter(string, string)

ResourceClient<PlanPerson>.AddCustomParameter(string, string)

ResourceClient<PlanPerson>.ClearParameters()

ResourceClient<PlanPerson>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PlanPerson>.Uri

ResourceClient<PlanPerson>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PlanPersonClient(HttpClient, Uri)

Client for interacting with the PlanPerson resource.

public PlanPersonClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

DeclinedPlanTimes

Associated DeclinedPlanTimes.

public PaginatedPlanTimeClient DeclinedPlanTimes { get; }

Property Value

PaginatedPlanTimeClient

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Plan

Associated Plan.

public PlanClient Plan { get; }

Property Value

PlanClient

PlanPersonTimes

Associated PlanPersonTimes.

public PaginatedPlanPersonTimeClient PlanPersonTimes { get; }

Property Value

PaginatedPlanPersonTimeClient

PlanTimes

Associated PlanTimes.

public PaginatedPlanTimeClient PlanTimes { get; }

Property Value

PaginatedPlanTimeClient

Team

Associated Team.

public TeamClient Team { get; }

Property Value

TeamClient

Methods

DeleteAsync(CancellationToken)

Deletes the PlanPerson resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the PlanPerson resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanPersonResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeDeclinedPlanTimes()

Include related DeclinedPlanTimes resources in the response.

public PlanPersonClient IncludeDeclinedPlanTimes()

Returns

PlanPersonClient

IncludePerson()

Include related Person resources in the response.

public PlanPersonClient IncludePerson()

Returns

PlanPersonClient

IncludePlan()

Include related Plan resources in the response.

public PlanPersonClient IncludePlan()

Returns

PlanPersonClient

IncludeTeam()

Include related Team resources in the response.

public PlanPersonClient IncludeTeam()

Returns

PlanPersonClient

PatchAsync(PlanPerson, CancellationToken)

Updates an existing PlanPerson resource asynchronously.

public Task<PlanPersonResponse> PatchAsync(PlanPerson resource, CancellationToken cancellationToken = default)

Parameters

resource PlanPerson

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanPersonResponse>

A task representing the asynchronous operation, containing the updated PlanPerson resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<PlanPersonResource>, CancellationToken)

Updates an existing PlanPerson resource asynchronously.

public Task<PlanPersonResponse> PatchAsync(JsonApiDocument<PlanPersonResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<PlanPersonResource>

The JSON:API document to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanPersonResponse>

A task representing the asynchronous operation, containing the updated PlanPerson resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.