Class PlanTimeClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PlanTime resource.

public class PlanTimeClient : SingletonResourceClient<PlanTime, PlanTimeResource, PlanTimeResponse>

Inheritance

object

ResourceClient<PlanTime>

SingletonResourceClient<PlanTime, PlanTimeResource, PlanTimeResponse>

PlanTimeClient

Inherited Members

SingletonResourceClient<PlanTime, PlanTimeResource, PlanTimeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PlanTime, PlanTimeResource, PlanTimeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PlanTime, PlanTimeResource, PlanTimeResponse>.PatchAsync(PlanTime, CancellationToken)

SingletonResourceClient<PlanTime, PlanTimeResource, PlanTimeResponse>.PatchAsync(JsonApiDocument<PlanTimeResource>, CancellationToken)

SingletonResourceClient<PlanTime, PlanTimeResource, PlanTimeResponse>.DeleteAsync(CancellationToken)

ResourceClient<PlanTime>.AddQueryParameter(string, string)

ResourceClient<PlanTime>.ReplaceQueryParameter(string, string)

ResourceClient<PlanTime>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PlanTime>.Uri

ResourceClient<PlanTime>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PlanTimeClient(HttpClient, Uri)

Client for interacting with the PlanTime resource.

public PlanTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

SplitTeamRehearsalAssignments

Associated SplitTeamRehearsalAssignments.

public PaginatedSplitTeamRehearsalAssignmentClient SplitTeamRehearsalAssignments { get; }

Property Value

PaginatedSplitTeamRehearsalAssignmentClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PlanTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PlanTimeClient

The current PlanTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PlanTimeClient ClearParameters()

Returns

PlanTimeClient

The current PlanTimeClient instance.

DeleteAsync(CancellationToken)

Deletes the PlanTime 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 PlanTime resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeSplitTeamRehearsalAssignments()

Include related SplitTeamRehearsalAssignments resources in the response.

public PlanTimeClient IncludeSplitTeamRehearsalAssignments()

Returns

PlanTimeClient

PatchAsync(PlanTime, CancellationToken)

Updates an existing PlanTime resource asynchronously.

public Task<PlanTimeResponse> PatchAsync(PlanTime resource, CancellationToken cancellationToken = default)

Parameters

resource PlanTime

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<PlanTimeResource>, CancellationToken)

Updates an existing PlanTime resource asynchronously.

public Task<PlanTimeResponse> PatchAsync(JsonApiDocument<PlanTimeResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<PlanTimeResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.