Class PaginatedCustomSlideClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with CustomSlide collection resources.

public class PaginatedCustomSlideClient : PaginatedResourceClient<CustomSlide, CustomSlideResource, CustomSlideCollectionResponse, CustomSlideResponse>

Inheritance

object

ResourceClient<CustomSlide>

PaginatedResourceClient<CustomSlide, CustomSlideResource, CustomSlideCollectionResponse, CustomSlideResponse>

PaginatedCustomSlideClient

Inherited Members

PaginatedResourceClient<CustomSlide, CustomSlideResource, CustomSlideCollectionResponse, CustomSlideResponse>.PerPage(int)

PaginatedResourceClient<CustomSlide, CustomSlideResource, CustomSlideCollectionResponse, CustomSlideResponse>.Offset(int)

PaginatedResourceClient<CustomSlide, CustomSlideResource, CustomSlideCollectionResponse, CustomSlideResponse>.Filter(string)

PaginatedResourceClient<CustomSlide, CustomSlideResource, CustomSlideCollectionResponse, CustomSlideResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<CustomSlide, CustomSlideResource, CustomSlideCollectionResponse, CustomSlideResponse>.PostAsync(CustomSlide, CancellationToken)

PaginatedResourceClient<CustomSlide, CustomSlideResource, CustomSlideCollectionResponse, CustomSlideResponse>.PostAsync(JsonApiDocument<CustomSlideResource>, CancellationToken)

ResourceClient<CustomSlide>.AddQueryParameter(string, string)

ResourceClient<CustomSlide>.ReplaceQueryParameter(string, string)

ResourceClient<CustomSlide>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<CustomSlide>.Uri

ResourceClient<CustomSlide>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedCustomSlideClient(HttpClient, Uri)

Client for interacting with CustomSlide collection resources.

public PaginatedCustomSlideClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedCustomSlideClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedCustomSlideClient

The current PaginatedCustomSlideClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedCustomSlideClient ClearParameters()

Returns

PaginatedCustomSlideClient

The current PaginatedCustomSlideClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedCustomSlideClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedCustomSlideClient

The current PaginatedCustomSlideClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of CustomSlide resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CustomSlideCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedCustomSlideClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedCustomSlideClient

The current PaginatedCustomSlideClient instance.

PerPage(int)

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

public PaginatedCustomSlideClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedCustomSlideClient

The current PaginatedCustomSlideClient instance.

PostAsync(CustomSlide, CancellationToken)

Creates a new CustomSlide resource asynchronously.

public Task<CustomSlideResponse> PostAsync(CustomSlide resource, CancellationToken cancellationToken = default)

Parameters

resource CustomSlide

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CustomSlideResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<CustomSlideResource>, CancellationToken)

Creates a new CustomSlide resource asynchronously.

public Task<CustomSlideResponse> PostAsync(JsonApiDocument<CustomSlideResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<CustomSlideResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CustomSlideResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public CustomSlideClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

CustomSlideClient

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