Class ServiceTimeClient

Namespace

Crews.PlanningCenter.Api.People.V2020_04_06

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ServiceTime resource.

public class ServiceTimeClient : SingletonResourceClient<ServiceTime, ServiceTimeResource, ServiceTimeResponse>

Inheritance

object

ResourceClient<ServiceTime>

SingletonResourceClient<ServiceTime, ServiceTimeResource, ServiceTimeResponse>

ServiceTimeClient

Inherited Members

SingletonResourceClient<ServiceTime, ServiceTimeResource, ServiceTimeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ServiceTime, ServiceTimeResource, ServiceTimeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ServiceTime, ServiceTimeResource, ServiceTimeResponse>.PatchAsync(ServiceTime, CancellationToken)

SingletonResourceClient<ServiceTime, ServiceTimeResource, ServiceTimeResponse>.PatchAsync(JsonApiDocument<ServiceTimeResource>, CancellationToken)

SingletonResourceClient<ServiceTime, ServiceTimeResource, ServiceTimeResponse>.DeleteAsync(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

ServiceTimeClient(HttpClient, Uri)

Client for interacting with the ServiceTime resource.

public ServiceTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

DeleteAsync(CancellationToken)

Deletes the ServiceTime resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the ServiceTime resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ServiceTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(ServiceTime, CancellationToken)

Updates an existing ServiceTime resource asynchronously.

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

Parameters

resource ServiceTime

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ServiceTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<ServiceTimeResource>, CancellationToken)

Updates an existing ServiceTime resource asynchronously.

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

Parameters

document JsonApiDocument<ServiceTimeResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ServiceTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.