Class PaginatedBlockoutExceptionClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with BlockoutException collection resources.

public class PaginatedBlockoutExceptionClient : PaginatedResourceClient<BlockoutException, BlockoutExceptionResource, BlockoutExceptionCollectionResponse, BlockoutExceptionResponse>

Inheritance

object

ResourceClient<BlockoutException>

PaginatedResourceClient<BlockoutException, BlockoutExceptionResource, BlockoutExceptionCollectionResponse, BlockoutExceptionResponse>

PaginatedBlockoutExceptionClient

Inherited Members

PaginatedResourceClient<BlockoutException, BlockoutExceptionResource, BlockoutExceptionCollectionResponse, BlockoutExceptionResponse>.PerPage(int)

PaginatedResourceClient<BlockoutException, BlockoutExceptionResource, BlockoutExceptionCollectionResponse, BlockoutExceptionResponse>.Offset(int)

PaginatedResourceClient<BlockoutException, BlockoutExceptionResource, BlockoutExceptionCollectionResponse, BlockoutExceptionResponse>.Filter(string)

PaginatedResourceClient<BlockoutException, BlockoutExceptionResource, BlockoutExceptionCollectionResponse, BlockoutExceptionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<BlockoutException, BlockoutExceptionResource, BlockoutExceptionCollectionResponse, BlockoutExceptionResponse>.PostAsync(BlockoutException, CancellationToken)

PaginatedResourceClient<BlockoutException, BlockoutExceptionResource, BlockoutExceptionCollectionResponse, BlockoutExceptionResponse>.PostAsync(JsonApiDocument<BlockoutExceptionResource>, CancellationToken)

ResourceClient<BlockoutException>.AddQueryParameter(string, string)

ResourceClient<BlockoutException>.ReplaceQueryParameter(string, string)

ResourceClient<BlockoutException>.AddCustomParameter(string, string)

ResourceClient<BlockoutException>.ClearParameters()

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

PaginatedBlockoutExceptionClient(HttpClient, Uri)

Client for interacting with BlockoutException collection resources.

public PaginatedBlockoutExceptionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of BlockoutException resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BlockoutExceptionCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(BlockoutException, CancellationToken)

Creates a new BlockoutException resource asynchronously.

public Task<BlockoutExceptionResponse> PostAsync(BlockoutException resource, CancellationToken cancellationToken = default)

Parameters

resource BlockoutException

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BlockoutExceptionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<BlockoutExceptionResource>, CancellationToken)

Creates a new BlockoutException resource asynchronously.

public Task<BlockoutExceptionResponse> PostAsync(JsonApiDocument<BlockoutExceptionResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<BlockoutExceptionResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BlockoutExceptionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public BlockoutExceptionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

BlockoutExceptionClient

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