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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedBlockoutExceptionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedBlockoutExceptionClient

The current PaginatedBlockoutExceptionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedBlockoutExceptionClient ClearParameters()

Returns

PaginatedBlockoutExceptionClient

The current PaginatedBlockoutExceptionClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedBlockoutExceptionClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedBlockoutExceptionClient

The current PaginatedBlockoutExceptionClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedBlockoutExceptionClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedBlockoutExceptionClient

The current PaginatedBlockoutExceptionClient instance.

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedBlockoutExceptionClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedBlockoutExceptionClient

The current PaginatedBlockoutExceptionClient instance.

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.