Class PaginatedBlockoutDateClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with BlockoutDate collection resources.

public class PaginatedBlockoutDateClient : PaginatedResourceClient<BlockoutDate, BlockoutDateResource, BlockoutDateCollectionResponse, BlockoutDateResponse>

Inheritance

object

ResourceClient<BlockoutDate>

PaginatedResourceClient<BlockoutDate, BlockoutDateResource, BlockoutDateCollectionResponse, BlockoutDateResponse>

PaginatedBlockoutDateClient

Inherited Members

PaginatedResourceClient<BlockoutDate, BlockoutDateResource, BlockoutDateCollectionResponse, BlockoutDateResponse>.PerPage(int)

PaginatedResourceClient<BlockoutDate, BlockoutDateResource, BlockoutDateCollectionResponse, BlockoutDateResponse>.Offset(int)

PaginatedResourceClient<BlockoutDate, BlockoutDateResource, BlockoutDateCollectionResponse, BlockoutDateResponse>.Filter(string)

PaginatedResourceClient<BlockoutDate, BlockoutDateResource, BlockoutDateCollectionResponse, BlockoutDateResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<BlockoutDate, BlockoutDateResource, BlockoutDateCollectionResponse, BlockoutDateResponse>.PostAsync(BlockoutDate, CancellationToken)

PaginatedResourceClient<BlockoutDate, BlockoutDateResource, BlockoutDateCollectionResponse, BlockoutDateResponse>.PostAsync(JsonApiDocument<BlockoutDateResource>, CancellationToken)

ResourceClient<BlockoutDate>.AddQueryParameter(string, string)

ResourceClient<BlockoutDate>.ReplaceQueryParameter(string, string)

ResourceClient<BlockoutDate>.AddCustomParameter(string, string)

ResourceClient<BlockoutDate>.ClearParameters()

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

PaginatedBlockoutDateClient(HttpClient, Uri)

Client for interacting with BlockoutDate collection resources.

public PaginatedBlockoutDateClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of BlockoutDate resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BlockoutDateCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public BlockoutDateClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

BlockoutDateClient

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