Class PaginatedNoteCategorySubscriptionClient

Namespace

Crews.PlanningCenter.Api.People.V2023_02_15

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with NoteCategorySubscription collection resources.

public class PaginatedNoteCategorySubscriptionClient : PaginatedResourceClient<NoteCategorySubscription, NoteCategorySubscriptionResource, NoteCategorySubscriptionCollectionResponse, NoteCategorySubscriptionResponse>

Inheritance

object

ResourceClient<NoteCategorySubscription>

PaginatedResourceClient<NoteCategorySubscription, NoteCategorySubscriptionResource, NoteCategorySubscriptionCollectionResponse, NoteCategorySubscriptionResponse>

PaginatedNoteCategorySubscriptionClient

Inherited Members

PaginatedResourceClient<NoteCategorySubscription, NoteCategorySubscriptionResource, NoteCategorySubscriptionCollectionResponse, NoteCategorySubscriptionResponse>.PerPage(int)

PaginatedResourceClient<NoteCategorySubscription, NoteCategorySubscriptionResource, NoteCategorySubscriptionCollectionResponse, NoteCategorySubscriptionResponse>.Offset(int)

PaginatedResourceClient<NoteCategorySubscription, NoteCategorySubscriptionResource, NoteCategorySubscriptionCollectionResponse, NoteCategorySubscriptionResponse>.Filter(string)

PaginatedResourceClient<NoteCategorySubscription, NoteCategorySubscriptionResource, NoteCategorySubscriptionCollectionResponse, NoteCategorySubscriptionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<NoteCategorySubscription, NoteCategorySubscriptionResource, NoteCategorySubscriptionCollectionResponse, NoteCategorySubscriptionResponse>.PostAsync(NoteCategorySubscription, CancellationToken)

PaginatedResourceClient<NoteCategorySubscription, NoteCategorySubscriptionResource, NoteCategorySubscriptionCollectionResponse, NoteCategorySubscriptionResponse>.PostAsync(JsonApiDocument<NoteCategorySubscriptionResource>, CancellationToken)

ResourceClient<NoteCategorySubscription>.AddQueryParameter(string, string)

ResourceClient<NoteCategorySubscription>.ReplaceQueryParameter(string, string)

ResourceClient<NoteCategorySubscription>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<NoteCategorySubscription>.Uri

ResourceClient<NoteCategorySubscription>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedNoteCategorySubscriptionClient(HttpClient, Uri)

Client for interacting with NoteCategorySubscription collection resources.

public PaginatedNoteCategorySubscriptionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedNoteCategorySubscriptionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedNoteCategorySubscriptionClient

The current PaginatedNoteCategorySubscriptionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedNoteCategorySubscriptionClient ClearParameters()

Returns

PaginatedNoteCategorySubscriptionClient

The current PaginatedNoteCategorySubscriptionClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedNoteCategorySubscriptionClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedNoteCategorySubscriptionClient

The current PaginatedNoteCategorySubscriptionClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of NoteCategorySubscription resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteCategorySubscriptionCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePerson()

Include related Person resources in the response.

public NoteCategorySubscriptionClient IncludePerson()

Returns

NoteCategorySubscriptionClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedNoteCategorySubscriptionClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedNoteCategorySubscriptionClient

The current PaginatedNoteCategorySubscriptionClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public NoteCategorySubscriptionClient OrderByCreatedAt()

Returns

NoteCategorySubscriptionClient

OrderByCreatedAtDescending()

Sort response items by the CreatedAt attribute. Use reverse order.

public NoteCategorySubscriptionClient OrderByCreatedAtDescending()

Returns

NoteCategorySubscriptionClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public NoteCategorySubscriptionClient OrderByUpdatedAt()

Returns

NoteCategorySubscriptionClient

OrderByUpdatedAtDescending()

Sort response items by the UpdatedAt attribute. Use reverse order.

public NoteCategorySubscriptionClient OrderByUpdatedAtDescending()

Returns

NoteCategorySubscriptionClient

PerPage(int)

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

public PaginatedNoteCategorySubscriptionClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedNoteCategorySubscriptionClient

The current PaginatedNoteCategorySubscriptionClient instance.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public NoteCategorySubscriptionClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

NoteCategorySubscriptionClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public NoteCategorySubscriptionClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

NoteCategorySubscriptionClient

WithId(string)

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

public NoteCategorySubscriptionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

NoteCategorySubscriptionClient

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