Class PaginatedNoteCategoryShareClient

Namespace

Crews.PlanningCenter.Api.People.V2025_11_10

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with NoteCategoryShare collection resources.

public class PaginatedNoteCategoryShareClient : PaginatedResourceClient<NoteCategoryShare, NoteCategoryShareResource, NoteCategoryShareCollectionResponse, NoteCategoryShareResponse>

Inheritance

object

ResourceClient<NoteCategoryShare>

PaginatedResourceClient<NoteCategoryShare, NoteCategoryShareResource, NoteCategoryShareCollectionResponse, NoteCategoryShareResponse>

PaginatedNoteCategoryShareClient

Inherited Members

PaginatedResourceClient<NoteCategoryShare, NoteCategoryShareResource, NoteCategoryShareCollectionResponse, NoteCategoryShareResponse>.PerPage(int)

PaginatedResourceClient<NoteCategoryShare, NoteCategoryShareResource, NoteCategoryShareCollectionResponse, NoteCategoryShareResponse>.Offset(int)

PaginatedResourceClient<NoteCategoryShare, NoteCategoryShareResource, NoteCategoryShareCollectionResponse, NoteCategoryShareResponse>.Filter(string)

PaginatedResourceClient<NoteCategoryShare, NoteCategoryShareResource, NoteCategoryShareCollectionResponse, NoteCategoryShareResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<NoteCategoryShare, NoteCategoryShareResource, NoteCategoryShareCollectionResponse, NoteCategoryShareResponse>.PostAsync(NoteCategoryShare, CancellationToken)

PaginatedResourceClient<NoteCategoryShare, NoteCategoryShareResource, NoteCategoryShareCollectionResponse, NoteCategoryShareResponse>.PostAsync(JsonApiDocument<NoteCategoryShareResource>, CancellationToken)

ResourceClient<NoteCategoryShare>.AddQueryParameter(string, string)

ResourceClient<NoteCategoryShare>.ReplaceQueryParameter(string, string)

ResourceClient<NoteCategoryShare>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<NoteCategoryShare>.Uri

ResourceClient<NoteCategoryShare>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedNoteCategoryShareClient(HttpClient, Uri)

Client for interacting with NoteCategoryShare collection resources.

public PaginatedNoteCategoryShareClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedNoteCategoryShareClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedNoteCategoryShareClient

The current PaginatedNoteCategoryShareClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedNoteCategoryShareClient ClearParameters()

Returns

PaginatedNoteCategoryShareClient

The current PaginatedNoteCategoryShareClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedNoteCategoryShareClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedNoteCategoryShareClient

The current PaginatedNoteCategoryShareClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of NoteCategoryShare resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteCategoryShareCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePerson()

Include related Person resources in the response.

public NoteCategoryShareClient IncludePerson()

Returns

NoteCategoryShareClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedNoteCategoryShareClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedNoteCategoryShareClient

The current PaginatedNoteCategoryShareClient instance.

PerPage(int)

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

public PaginatedNoteCategoryShareClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedNoteCategoryShareClient

The current PaginatedNoteCategoryShareClient instance.

PostAsync(NoteCategoryShare, CancellationToken)

Creates a new NoteCategoryShare resource asynchronously.

public Task<NoteCategoryShareResponse> PostAsync(NoteCategoryShare resource, CancellationToken cancellationToken = default)

Parameters

resource NoteCategoryShare

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteCategoryShareResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<NoteCategoryShareResource>, CancellationToken)

Creates a new NoteCategoryShare resource asynchronously.

public Task<NoteCategoryShareResponse> PostAsync(JsonApiDocument<NoteCategoryShareResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<NoteCategoryShareResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteCategoryShareResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WherePermission(string)

Query response items by the Permission attribute.

public NoteCategoryShareClient WherePermission(string value)

Parameters

value string

Returns

NoteCategoryShareClient

WithId(string)

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

public NoteCategoryShareClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

NoteCategoryShareClient

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