Class BlockoutDateClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the BlockoutDate resource.

public class BlockoutDateClient : SingletonResourceClient<BlockoutDate, BlockoutDateResource, BlockoutDateResponse>

Inheritance

object

ResourceClient<BlockoutDate>

SingletonResourceClient<BlockoutDate, BlockoutDateResource, BlockoutDateResponse>

BlockoutDateClient

Inherited Members

SingletonResourceClient<BlockoutDate, BlockoutDateResource, BlockoutDateResponse>.GetAsync(CancellationToken)

SingletonResourceClient<BlockoutDate, BlockoutDateResource, BlockoutDateResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<BlockoutDate, BlockoutDateResource, BlockoutDateResponse>.PatchAsync(BlockoutDate, CancellationToken)

SingletonResourceClient<BlockoutDate, BlockoutDateResource, BlockoutDateResponse>.PatchAsync(JsonApiDocument<BlockoutDateResource>, CancellationToken)

SingletonResourceClient<BlockoutDate, BlockoutDateResource, BlockoutDateResponse>.DeleteAsync(CancellationToken)

ResourceClient<BlockoutDate>.AddQueryParameter(string, string)

ResourceClient<BlockoutDate>.ReplaceQueryParameter(string, string)

ResourceClient<BlockoutDate>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<BlockoutDate>.Uri

ResourceClient<BlockoutDate>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

BlockoutDateClient(HttpClient, Uri)

Client for interacting with the BlockoutDate resource.

public BlockoutDateClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public BlockoutDateClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

BlockoutDateClient

The current BlockoutDateClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public BlockoutDateClient ClearParameters()

Returns

BlockoutDateClient

The current BlockoutDateClient instance.

GetAsync(CancellationToken)

Fetches the BlockoutDate resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BlockoutDateResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.