Class PaginatedPlanNoteCategoryClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PlanNoteCategory collection resources.

public class PaginatedPlanNoteCategoryClient : PaginatedResourceClient<PlanNoteCategory, PlanNoteCategoryResource, PlanNoteCategoryCollectionResponse, PlanNoteCategoryResponse>

Inheritance

object

ResourceClient<PlanNoteCategory>

PaginatedResourceClient<PlanNoteCategory, PlanNoteCategoryResource, PlanNoteCategoryCollectionResponse, PlanNoteCategoryResponse>

PaginatedPlanNoteCategoryClient

Inherited Members

PaginatedResourceClient<PlanNoteCategory, PlanNoteCategoryResource, PlanNoteCategoryCollectionResponse, PlanNoteCategoryResponse>.PerPage(int)

PaginatedResourceClient<PlanNoteCategory, PlanNoteCategoryResource, PlanNoteCategoryCollectionResponse, PlanNoteCategoryResponse>.Offset(int)

PaginatedResourceClient<PlanNoteCategory, PlanNoteCategoryResource, PlanNoteCategoryCollectionResponse, PlanNoteCategoryResponse>.Filter(string)

PaginatedResourceClient<PlanNoteCategory, PlanNoteCategoryResource, PlanNoteCategoryCollectionResponse, PlanNoteCategoryResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PlanNoteCategory, PlanNoteCategoryResource, PlanNoteCategoryCollectionResponse, PlanNoteCategoryResponse>.PostAsync(PlanNoteCategory, CancellationToken)

PaginatedResourceClient<PlanNoteCategory, PlanNoteCategoryResource, PlanNoteCategoryCollectionResponse, PlanNoteCategoryResponse>.PostAsync(JsonApiDocument<PlanNoteCategoryResource>, CancellationToken)

ResourceClient<PlanNoteCategory>.AddQueryParameter(string, string)

ResourceClient<PlanNoteCategory>.ReplaceQueryParameter(string, string)

ResourceClient<PlanNoteCategory>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PlanNoteCategory>.Uri

ResourceClient<PlanNoteCategory>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPlanNoteCategoryClient(HttpClient, Uri)

Client for interacting with PlanNoteCategory collection resources.

public PaginatedPlanNoteCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPlanNoteCategoryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPlanNoteCategoryClient

The current PaginatedPlanNoteCategoryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPlanNoteCategoryClient ClearParameters()

Returns

PaginatedPlanNoteCategoryClient

The current PaginatedPlanNoteCategoryClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPlanNoteCategoryClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPlanNoteCategoryClient

The current PaginatedPlanNoteCategoryClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of PlanNoteCategory resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanNoteCategoryCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPlanNoteCategoryClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPlanNoteCategoryClient

The current PaginatedPlanNoteCategoryClient instance.

PerPage(int)

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

public PaginatedPlanNoteCategoryClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPlanNoteCategoryClient

The current PaginatedPlanNoteCategoryClient instance.

WithId(string)

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

public PlanNoteCategoryClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PlanNoteCategoryClient

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