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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPlanPersonTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPlanPersonTimeClient

The current PaginatedPlanPersonTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPlanPersonTimeClient ClearParameters()

Returns

PaginatedPlanPersonTimeClient

The current PaginatedPlanPersonTimeClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPlanPersonTimeClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPlanPersonTimeClient

The current PaginatedPlanPersonTimeClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPlanPersonTimeClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPlanPersonTimeClient

The current PaginatedPlanPersonTimeClient instance.

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public PlanPersonTimeClient OrderByUpdatedAt()

Returns

PlanPersonTimeClient

OrderByUpdatedAtDescending()

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

public PlanPersonTimeClient OrderByUpdatedAtDescending()

Returns

PlanPersonTimeClient

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedPlanPersonTimeClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPlanPersonTimeClient

The current PaginatedPlanPersonTimeClient instance.

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.