Class PaginatedItemNoteCategoryClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ItemNoteCategory collection resources.

public class PaginatedItemNoteCategoryClient : PaginatedResourceClient<ItemNoteCategory, ItemNoteCategoryResource, ItemNoteCategoryCollectionResponse, ItemNoteCategoryResponse>

Inheritance

object

ResourceClient<ItemNoteCategory>

PaginatedResourceClient<ItemNoteCategory, ItemNoteCategoryResource, ItemNoteCategoryCollectionResponse, ItemNoteCategoryResponse>

PaginatedItemNoteCategoryClient

Inherited Members

PaginatedResourceClient<ItemNoteCategory, ItemNoteCategoryResource, ItemNoteCategoryCollectionResponse, ItemNoteCategoryResponse>.PerPage(int)

PaginatedResourceClient<ItemNoteCategory, ItemNoteCategoryResource, ItemNoteCategoryCollectionResponse, ItemNoteCategoryResponse>.Offset(int)

PaginatedResourceClient<ItemNoteCategory, ItemNoteCategoryResource, ItemNoteCategoryCollectionResponse, ItemNoteCategoryResponse>.Filter(string)

PaginatedResourceClient<ItemNoteCategory, ItemNoteCategoryResource, ItemNoteCategoryCollectionResponse, ItemNoteCategoryResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ItemNoteCategory, ItemNoteCategoryResource, ItemNoteCategoryCollectionResponse, ItemNoteCategoryResponse>.PostAsync(ItemNoteCategory, CancellationToken)

PaginatedResourceClient<ItemNoteCategory, ItemNoteCategoryResource, ItemNoteCategoryCollectionResponse, ItemNoteCategoryResponse>.PostAsync(JsonApiDocument<ItemNoteCategoryResource>, CancellationToken)

ResourceClient<ItemNoteCategory>.AddQueryParameter(string, string)

ResourceClient<ItemNoteCategory>.ReplaceQueryParameter(string, string)

ResourceClient<ItemNoteCategory>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ItemNoteCategory>.Uri

ResourceClient<ItemNoteCategory>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedItemNoteCategoryClient(HttpClient, Uri)

Client for interacting with ItemNoteCategory collection resources.

public PaginatedItemNoteCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedItemNoteCategoryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedItemNoteCategoryClient

The current PaginatedItemNoteCategoryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedItemNoteCategoryClient ClearParameters()

Returns

PaginatedItemNoteCategoryClient

The current PaginatedItemNoteCategoryClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedItemNoteCategoryClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedItemNoteCategoryClient

The current PaginatedItemNoteCategoryClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of ItemNoteCategory resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemNoteCategoryCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedItemNoteCategoryClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedItemNoteCategoryClient

The current PaginatedItemNoteCategoryClient instance.

PerPage(int)

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

public PaginatedItemNoteCategoryClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedItemNoteCategoryClient

The current PaginatedItemNoteCategoryClient instance.

WithId(string)

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

public ItemNoteCategoryClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ItemNoteCategoryClient

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