Class PaginatedBlockoutScheduleConflictClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with BlockoutScheduleConflict collection resources.

public class PaginatedBlockoutScheduleConflictClient : PaginatedResourceClient<BlockoutScheduleConflict, BlockoutScheduleConflictResource, BlockoutScheduleConflictCollectionResponse, BlockoutScheduleConflictResponse>

Inheritance

object

ResourceClient<BlockoutScheduleConflict>

PaginatedResourceClient<BlockoutScheduleConflict, BlockoutScheduleConflictResource, BlockoutScheduleConflictCollectionResponse, BlockoutScheduleConflictResponse>

PaginatedBlockoutScheduleConflictClient

Inherited Members

PaginatedResourceClient<BlockoutScheduleConflict, BlockoutScheduleConflictResource, BlockoutScheduleConflictCollectionResponse, BlockoutScheduleConflictResponse>.PerPage(int)

PaginatedResourceClient<BlockoutScheduleConflict, BlockoutScheduleConflictResource, BlockoutScheduleConflictCollectionResponse, BlockoutScheduleConflictResponse>.Offset(int)

PaginatedResourceClient<BlockoutScheduleConflict, BlockoutScheduleConflictResource, BlockoutScheduleConflictCollectionResponse, BlockoutScheduleConflictResponse>.Filter(string)

PaginatedResourceClient<BlockoutScheduleConflict, BlockoutScheduleConflictResource, BlockoutScheduleConflictCollectionResponse, BlockoutScheduleConflictResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<BlockoutScheduleConflict, BlockoutScheduleConflictResource, BlockoutScheduleConflictCollectionResponse, BlockoutScheduleConflictResponse>.PostAsync(BlockoutScheduleConflict, CancellationToken)

PaginatedResourceClient<BlockoutScheduleConflict, BlockoutScheduleConflictResource, BlockoutScheduleConflictCollectionResponse, BlockoutScheduleConflictResponse>.PostAsync(JsonApiDocument<BlockoutScheduleConflictResource>, CancellationToken)

ResourceClient<BlockoutScheduleConflict>.AddQueryParameter(string, string)

ResourceClient<BlockoutScheduleConflict>.ReplaceQueryParameter(string, string)

ResourceClient<BlockoutScheduleConflict>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<BlockoutScheduleConflict>.Uri

ResourceClient<BlockoutScheduleConflict>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedBlockoutScheduleConflictClient(HttpClient, Uri)

Client for interacting with BlockoutScheduleConflict collection resources.

public PaginatedBlockoutScheduleConflictClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedBlockoutScheduleConflictClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedBlockoutScheduleConflictClient

The current PaginatedBlockoutScheduleConflictClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedBlockoutScheduleConflictClient ClearParameters()

Returns

PaginatedBlockoutScheduleConflictClient

The current PaginatedBlockoutScheduleConflictClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedBlockoutScheduleConflictClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedBlockoutScheduleConflictClient

The current PaginatedBlockoutScheduleConflictClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of BlockoutScheduleConflict resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BlockoutScheduleConflictCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedBlockoutScheduleConflictClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedBlockoutScheduleConflictClient

The current PaginatedBlockoutScheduleConflictClient instance.

PerPage(int)

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

public PaginatedBlockoutScheduleConflictClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedBlockoutScheduleConflictClient

The current PaginatedBlockoutScheduleConflictClient instance.

WithId(string)

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

public BlockoutScheduleConflictClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

BlockoutScheduleConflictClient

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