Class PaginatedItemClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Item collection resources.

public class PaginatedItemClient : PaginatedResourceClient<Item, ItemResource, ItemCollectionResponse, ItemResponse>

Inheritance

object

ResourceClient<Item>

PaginatedResourceClient<Item, ItemResource, ItemCollectionResponse, ItemResponse>

PaginatedItemClient

Inherited Members

PaginatedResourceClient<Item, ItemResource, ItemCollectionResponse, ItemResponse>.PerPage(int)

PaginatedResourceClient<Item, ItemResource, ItemCollectionResponse, ItemResponse>.Offset(int)

PaginatedResourceClient<Item, ItemResource, ItemCollectionResponse, ItemResponse>.Filter(string)

PaginatedResourceClient<Item, ItemResource, ItemCollectionResponse, ItemResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Item, ItemResource, ItemCollectionResponse, ItemResponse>.PostAsync(Item, CancellationToken)

PaginatedResourceClient<Item, ItemResource, ItemCollectionResponse, ItemResponse>.PostAsync(JsonApiDocument<ItemResource>, CancellationToken)

ResourceClient<Item>.AddQueryParameter(string, string)

ResourceClient<Item>.ReplaceQueryParameter(string, string)

ResourceClient<Item>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Item>.Uri

ResourceClient<Item>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedItemClient(HttpClient, Uri)

Client for interacting with Item collection resources.

public PaginatedItemClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedItemClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedItemClient

The current PaginatedItemClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedItemClient ClearParameters()

Returns

PaginatedItemClient

The current PaginatedItemClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedItemClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedItemClient

The current PaginatedItemClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Item resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeArrangement()

Include related Arrangement resources in the response.

public ItemClient IncludeArrangement()

Returns

ItemClient

IncludeItemAssignments()

Include related ItemAssignments resources in the response.

public ItemClient IncludeItemAssignments()

Returns

ItemClient

IncludeItemNotes()

Include related ItemNotes resources in the response.

public ItemClient IncludeItemNotes()

Returns

ItemClient

IncludeItemTimes()

Include related ItemTimes resources in the response.

public ItemClient IncludeItemTimes()

Returns

ItemClient

IncludeKey()

Include related Key resources in the response.

public ItemClient IncludeKey()

Returns

ItemClient

IncludeMedia()

Include related Media resources in the response.

public ItemClient IncludeMedia()

Returns

ItemClient

IncludeSelectedAttachment()

Include related SelectedAttachment resources in the response.

public ItemClient IncludeSelectedAttachment()

Returns

ItemClient

IncludeSong()

Include related Song resources in the response.

public ItemClient IncludeSong()

Returns

ItemClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedItemClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedItemClient

The current PaginatedItemClient instance.

PerPage(int)

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

public PaginatedItemClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedItemClient

The current PaginatedItemClient instance.

PostAsync(Item, CancellationToken)

Creates a new Item resource asynchronously.

public Task<ItemResponse> PostAsync(Item resource, CancellationToken cancellationToken = default)

Parameters

resource Item

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<ItemResource>, CancellationToken)

Creates a new Item resource asynchronously.

public Task<ItemResponse> PostAsync(JsonApiDocument<ItemResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ItemResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public ItemClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ItemClient

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