Class PaginatedPlanTimeClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PlanTime collection resources.

public class PaginatedPlanTimeClient : PaginatedResourceClient<PlanTime, PlanTimeResource, PlanTimeCollectionResponse, PlanTimeResponse>

Inheritance

object

ResourceClient<PlanTime>

PaginatedResourceClient<PlanTime, PlanTimeResource, PlanTimeCollectionResponse, PlanTimeResponse>

PaginatedPlanTimeClient

Inherited Members

PaginatedResourceClient<PlanTime, PlanTimeResource, PlanTimeCollectionResponse, PlanTimeResponse>.PerPage(int)

PaginatedResourceClient<PlanTime, PlanTimeResource, PlanTimeCollectionResponse, PlanTimeResponse>.Offset(int)

PaginatedResourceClient<PlanTime, PlanTimeResource, PlanTimeCollectionResponse, PlanTimeResponse>.Filter(string)

PaginatedResourceClient<PlanTime, PlanTimeResource, PlanTimeCollectionResponse, PlanTimeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PlanTime, PlanTimeResource, PlanTimeCollectionResponse, PlanTimeResponse>.PostAsync(PlanTime, CancellationToken)

PaginatedResourceClient<PlanTime, PlanTimeResource, PlanTimeCollectionResponse, PlanTimeResponse>.PostAsync(JsonApiDocument<PlanTimeResource>, CancellationToken)

ResourceClient<PlanTime>.AddQueryParameter(string, string)

ResourceClient<PlanTime>.ReplaceQueryParameter(string, string)

ResourceClient<PlanTime>.AddCustomParameter(string, string)

ResourceClient<PlanTime>.ClearParameters()

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

PaginatedPlanTimeClient(HttpClient, Uri)

Client for interacting with PlanTime collection resources.

public PaginatedPlanTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of PlanTime resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanTimeCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of PlanTime resources.

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

OrderByStartsAt()

Sort response items by the StartsAt attribute.

public PlanTimeClient OrderByStartsAt()

Returns

PlanTimeClient

OrderByStartsAtDescending()

Sort response items by the StartsAt attribute. Use reverse order.

public PlanTimeClient OrderByStartsAtDescending()

Returns

PlanTimeClient

PostAsync(PlanTime, CancellationToken)

Creates a new PlanTime resource asynchronously.

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

Parameters

resource PlanTime

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<PlanTimeResource>, CancellationToken)

Creates a new PlanTime resource asynchronously.

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

Parameters

document JsonApiDocument<PlanTimeResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereTimeType(string)

Query response items by the TimeType attribute.

public PlanTimeClient WhereTimeType(string value)

Parameters

value string

Returns

PlanTimeClient

WithId(string)

Creates a new instance of a PlanTime client for a specific resource ID.

public PlanTimeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PlanTimeClient

A new instance of the resource client for the specified resource ID.