Class PaginatedBlockoutClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Blockout collection resources.

public class PaginatedBlockoutClient : PaginatedResourceClient<Blockout, BlockoutResource, BlockoutCollectionResponse, BlockoutResponse>

Inheritance

object

ResourceClient<Blockout>

PaginatedResourceClient<Blockout, BlockoutResource, BlockoutCollectionResponse, BlockoutResponse>

PaginatedBlockoutClient

Inherited Members

PaginatedResourceClient<Blockout, BlockoutResource, BlockoutCollectionResponse, BlockoutResponse>.PerPage(int)

PaginatedResourceClient<Blockout, BlockoutResource, BlockoutCollectionResponse, BlockoutResponse>.Offset(int)

PaginatedResourceClient<Blockout, BlockoutResource, BlockoutCollectionResponse, BlockoutResponse>.Filter(string)

PaginatedResourceClient<Blockout, BlockoutResource, BlockoutCollectionResponse, BlockoutResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Blockout, BlockoutResource, BlockoutCollectionResponse, BlockoutResponse>.PostAsync(Blockout, CancellationToken)

PaginatedResourceClient<Blockout, BlockoutResource, BlockoutCollectionResponse, BlockoutResponse>.PostAsync(JsonApiDocument<BlockoutResource>, CancellationToken)

ResourceClient<Blockout>.AddQueryParameter(string, string)

ResourceClient<Blockout>.ReplaceQueryParameter(string, string)

ResourceClient<Blockout>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Blockout>.Uri

ResourceClient<Blockout>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedBlockoutClient(HttpClient, Uri)

Client for interacting with Blockout collection resources.

public PaginatedBlockoutClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedBlockoutClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedBlockoutClient

The current PaginatedBlockoutClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedBlockoutClient ClearParameters()

Returns

PaginatedBlockoutClient

The current PaginatedBlockoutClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedBlockoutClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedBlockoutClient

The current PaginatedBlockoutClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Blockout resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BlockoutCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedBlockoutClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedBlockoutClient

The current PaginatedBlockoutClient instance.

PerPage(int)

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

public PaginatedBlockoutClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedBlockoutClient

The current PaginatedBlockoutClient instance.

PostAsync(Blockout, CancellationToken)

Creates a new Blockout resource asynchronously.

public Task<BlockoutResponse> PostAsync(Blockout resource, CancellationToken cancellationToken = default)

Parameters

resource Blockout

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BlockoutResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<BlockoutResource>, CancellationToken)

Creates a new Blockout resource asynchronously.

public Task<BlockoutResponse> PostAsync(JsonApiDocument<BlockoutResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<BlockoutResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BlockoutResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereGroupIdentifier(string)

Query response items by the GroupIdentifier attribute.

public BlockoutClient WhereGroupIdentifier(string value)

Parameters

value string

Returns

BlockoutClient

WithId(string)

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

public BlockoutClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

BlockoutClient

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