Class PaginatedItemTimeClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ItemTime collection resources.

public class PaginatedItemTimeClient : PaginatedResourceClient<ItemTime, ItemTimeResource, ItemTimeCollectionResponse, ItemTimeResponse>

Inheritance

object

ResourceClient<ItemTime>

PaginatedResourceClient<ItemTime, ItemTimeResource, ItemTimeCollectionResponse, ItemTimeResponse>

PaginatedItemTimeClient

Inherited Members

PaginatedResourceClient<ItemTime, ItemTimeResource, ItemTimeCollectionResponse, ItemTimeResponse>.PerPage(int)

PaginatedResourceClient<ItemTime, ItemTimeResource, ItemTimeCollectionResponse, ItemTimeResponse>.Offset(int)

PaginatedResourceClient<ItemTime, ItemTimeResource, ItemTimeCollectionResponse, ItemTimeResponse>.Filter(string)

PaginatedResourceClient<ItemTime, ItemTimeResource, ItemTimeCollectionResponse, ItemTimeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ItemTime, ItemTimeResource, ItemTimeCollectionResponse, ItemTimeResponse>.PostAsync(ItemTime, CancellationToken)

PaginatedResourceClient<ItemTime, ItemTimeResource, ItemTimeCollectionResponse, ItemTimeResponse>.PostAsync(JsonApiDocument<ItemTimeResource>, CancellationToken)

ResourceClient<ItemTime>.AddQueryParameter(string, string)

ResourceClient<ItemTime>.ReplaceQueryParameter(string, string)

ResourceClient<ItemTime>.AddCustomParameter(string, string)

ResourceClient<ItemTime>.ClearParameters()

ResourceClient<ItemTime>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ItemTime>.Uri

ResourceClient<ItemTime>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedItemTimeClient(HttpClient, Uri)

Client for interacting with ItemTime collection resources.

public PaginatedItemTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of ItemTime resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemTimeCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public ItemTimeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ItemTimeClient

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