Class PaginatedServiceTimeClient

Namespace

Crews.PlanningCenter.Api.People.V2019_01_14

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ServiceTime collection resources.

public class PaginatedServiceTimeClient : PaginatedResourceClient<ServiceTime, ServiceTimeResource, ServiceTimeCollectionResponse, ServiceTimeResponse>

Inheritance

object

ResourceClient<ServiceTime>

PaginatedResourceClient<ServiceTime, ServiceTimeResource, ServiceTimeCollectionResponse, ServiceTimeResponse>

PaginatedServiceTimeClient

Inherited Members

PaginatedResourceClient<ServiceTime, ServiceTimeResource, ServiceTimeCollectionResponse, ServiceTimeResponse>.PerPage(int)

PaginatedResourceClient<ServiceTime, ServiceTimeResource, ServiceTimeCollectionResponse, ServiceTimeResponse>.Offset(int)

PaginatedResourceClient<ServiceTime, ServiceTimeResource, ServiceTimeCollectionResponse, ServiceTimeResponse>.Filter(string)

PaginatedResourceClient<ServiceTime, ServiceTimeResource, ServiceTimeCollectionResponse, ServiceTimeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ServiceTime, ServiceTimeResource, ServiceTimeCollectionResponse, ServiceTimeResponse>.PostAsync(ServiceTime, CancellationToken)

PaginatedResourceClient<ServiceTime, ServiceTimeResource, ServiceTimeCollectionResponse, ServiceTimeResponse>.PostAsync(JsonApiDocument<ServiceTimeResource>, CancellationToken)

ResourceClient<ServiceTime>.AddQueryParameter(string, string)

ResourceClient<ServiceTime>.ReplaceQueryParameter(string, string)

ResourceClient<ServiceTime>.AddCustomParameter(string, string)

ResourceClient<ServiceTime>.ClearParameters()

ResourceClient<ServiceTime>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ServiceTime>.Uri

ResourceClient<ServiceTime>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedServiceTimeClient(HttpClient, Uri)

Client for interacting with ServiceTime collection resources.

public PaginatedServiceTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of ServiceTime resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ServiceTimeCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderByTime()

Sort response items by the Time attribute.

public ServiceTimeClient OrderByTime()

Returns

ServiceTimeClient

OrderByTimeDescending()

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

public ServiceTimeClient OrderByTimeDescending()

Returns

ServiceTimeClient

PostAsync(ServiceTime, CancellationToken)

Creates a new ServiceTime resource asynchronously.

public Task<ServiceTimeResponse> PostAsync(ServiceTime resource, CancellationToken cancellationToken = default)

Parameters

resource ServiceTime

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ServiceTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<ServiceTimeResource>, CancellationToken)

Creates a new ServiceTime resource asynchronously.

public Task<ServiceTimeResponse> PostAsync(JsonApiDocument<ServiceTimeResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ServiceTimeResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ServiceTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public ServiceTimeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ServiceTimeClient

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