Class PaginatedPlanPersonTimeClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PlanPersonTime collection resources.

public class PaginatedPlanPersonTimeClient : PaginatedResourceClient<PlanPersonTime, PlanPersonTimeResource, PlanPersonTimeCollectionResponse, PlanPersonTimeResponse>

Inheritance

object

ResourceClient<PlanPersonTime>

PaginatedResourceClient<PlanPersonTime, PlanPersonTimeResource, PlanPersonTimeCollectionResponse, PlanPersonTimeResponse>

PaginatedPlanPersonTimeClient

Inherited Members

PaginatedResourceClient<PlanPersonTime, PlanPersonTimeResource, PlanPersonTimeCollectionResponse, PlanPersonTimeResponse>.PerPage(int)

PaginatedResourceClient<PlanPersonTime, PlanPersonTimeResource, PlanPersonTimeCollectionResponse, PlanPersonTimeResponse>.Offset(int)

PaginatedResourceClient<PlanPersonTime, PlanPersonTimeResource, PlanPersonTimeCollectionResponse, PlanPersonTimeResponse>.Filter(string)

PaginatedResourceClient<PlanPersonTime, PlanPersonTimeResource, PlanPersonTimeCollectionResponse, PlanPersonTimeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PlanPersonTime, PlanPersonTimeResource, PlanPersonTimeCollectionResponse, PlanPersonTimeResponse>.PostAsync(PlanPersonTime, CancellationToken)

PaginatedResourceClient<PlanPersonTime, PlanPersonTimeResource, PlanPersonTimeCollectionResponse, PlanPersonTimeResponse>.PostAsync(JsonApiDocument<PlanPersonTimeResource>, CancellationToken)

ResourceClient<PlanPersonTime>.AddQueryParameter(string, string)

ResourceClient<PlanPersonTime>.ReplaceQueryParameter(string, string)

ResourceClient<PlanPersonTime>.AddCustomParameter(string, string)

ResourceClient<PlanPersonTime>.ClearParameters()

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

PaginatedPlanPersonTimeClient(HttpClient, Uri)

Client for interacting with PlanPersonTime collection resources.

public PaginatedPlanPersonTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of PlanPersonTime resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanPersonTimeCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public PlanPersonTimeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PlanPersonTimeClient

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