Class BlockoutExceptionClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the BlockoutException resource.

public class BlockoutExceptionClient : SingletonResourceClient<BlockoutException, BlockoutExceptionResource, BlockoutExceptionResponse>

Inheritance

object

ResourceClient<BlockoutException>

SingletonResourceClient<BlockoutException, BlockoutExceptionResource, BlockoutExceptionResponse>

BlockoutExceptionClient

Inherited Members

SingletonResourceClient<BlockoutException, BlockoutExceptionResource, BlockoutExceptionResponse>.GetAsync(CancellationToken)

SingletonResourceClient<BlockoutException, BlockoutExceptionResource, BlockoutExceptionResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<BlockoutException, BlockoutExceptionResource, BlockoutExceptionResponse>.PatchAsync(BlockoutException, CancellationToken)

SingletonResourceClient<BlockoutException, BlockoutExceptionResource, BlockoutExceptionResponse>.PatchAsync(JsonApiDocument<BlockoutExceptionResource>, CancellationToken)

SingletonResourceClient<BlockoutException, BlockoutExceptionResource, BlockoutExceptionResponse>.DeleteAsync(CancellationToken)

ResourceClient<BlockoutException>.AddQueryParameter(string, string)

ResourceClient<BlockoutException>.ReplaceQueryParameter(string, string)

ResourceClient<BlockoutException>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<BlockoutException>.Uri

ResourceClient<BlockoutException>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

BlockoutExceptionClient(HttpClient, Uri)

Client for interacting with the BlockoutException resource.

public BlockoutExceptionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public BlockoutExceptionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

BlockoutExceptionClient

The current BlockoutExceptionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public BlockoutExceptionClient ClearParameters()

Returns

BlockoutExceptionClient

The current BlockoutExceptionClient instance.

GetAsync(CancellationToken)

Fetches the BlockoutException resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BlockoutExceptionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.