Class ItemTimeClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ItemTime resource.

public class ItemTimeClient : SingletonResourceClient<ItemTime, ItemTimeResource, ItemTimeResponse>

Inheritance

object

ResourceClient<ItemTime>

SingletonResourceClient<ItemTime, ItemTimeResource, ItemTimeResponse>

ItemTimeClient

Inherited Members

SingletonResourceClient<ItemTime, ItemTimeResource, ItemTimeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ItemTime, ItemTimeResource, ItemTimeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ItemTime, ItemTimeResource, ItemTimeResponse>.PatchAsync(ItemTime, CancellationToken)

SingletonResourceClient<ItemTime, ItemTimeResource, ItemTimeResponse>.PatchAsync(JsonApiDocument<ItemTimeResource>, CancellationToken)

SingletonResourceClient<ItemTime, ItemTimeResource, ItemTimeResponse>.DeleteAsync(CancellationToken)

ResourceClient<ItemTime>.AddQueryParameter(string, string)

ResourceClient<ItemTime>.ReplaceQueryParameter(string, string)

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

ItemTimeClient(HttpClient, Uri)

Client for interacting with the ItemTime resource.

public ItemTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ItemTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ItemTimeClient

The current ItemTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ItemTimeClient ClearParameters()

Returns

ItemTimeClient

The current ItemTimeClient instance.

GetAsync(CancellationToken)

Fetches the ItemTime resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.