Class PaginatedNoteCategoryClient

Namespace

Crews.PlanningCenter.Api.People.V2021_08_17

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with NoteCategory collection resources.

public class PaginatedNoteCategoryClient : PaginatedResourceClient<NoteCategory, NoteCategoryResource, NoteCategoryCollectionResponse, NoteCategoryResponse>

Inheritance

object

ResourceClient<NoteCategory>

PaginatedResourceClient<NoteCategory, NoteCategoryResource, NoteCategoryCollectionResponse, NoteCategoryResponse>

PaginatedNoteCategoryClient

Inherited Members

PaginatedResourceClient<NoteCategory, NoteCategoryResource, NoteCategoryCollectionResponse, NoteCategoryResponse>.PerPage(int)

PaginatedResourceClient<NoteCategory, NoteCategoryResource, NoteCategoryCollectionResponse, NoteCategoryResponse>.Offset(int)

PaginatedResourceClient<NoteCategory, NoteCategoryResource, NoteCategoryCollectionResponse, NoteCategoryResponse>.Filter(string)

PaginatedResourceClient<NoteCategory, NoteCategoryResource, NoteCategoryCollectionResponse, NoteCategoryResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<NoteCategory, NoteCategoryResource, NoteCategoryCollectionResponse, NoteCategoryResponse>.PostAsync(NoteCategory, CancellationToken)

PaginatedResourceClient<NoteCategory, NoteCategoryResource, NoteCategoryCollectionResponse, NoteCategoryResponse>.PostAsync(JsonApiDocument<NoteCategoryResource>, CancellationToken)

ResourceClient<NoteCategory>.AddQueryParameter(string, string)

ResourceClient<NoteCategory>.ReplaceQueryParameter(string, string)

ResourceClient<NoteCategory>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<NoteCategory>.Uri

ResourceClient<NoteCategory>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedNoteCategoryClient(HttpClient, Uri)

Client for interacting with NoteCategory collection resources.

public PaginatedNoteCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedNoteCategoryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedNoteCategoryClient

The current PaginatedNoteCategoryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedNoteCategoryClient ClearParameters()

Returns

PaginatedNoteCategoryClient

The current PaginatedNoteCategoryClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedNoteCategoryClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedNoteCategoryClient

The current PaginatedNoteCategoryClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of NoteCategory resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteCategoryCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeShares()

Include related Shares resources in the response.

public NoteCategoryClient IncludeShares()

Returns

NoteCategoryClient

IncludeSubscribers()

Include related Subscribers resources in the response.

public NoteCategoryClient IncludeSubscribers()

Returns

NoteCategoryClient

IncludeSubscriptions()

Include related Subscriptions resources in the response.

public NoteCategoryClient IncludeSubscriptions()

Returns

NoteCategoryClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedNoteCategoryClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedNoteCategoryClient

The current PaginatedNoteCategoryClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public NoteCategoryClient OrderByCreatedAt()

Returns

NoteCategoryClient

OrderByCreatedAtDescending()

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

public NoteCategoryClient OrderByCreatedAtDescending()

Returns

NoteCategoryClient

OrderByLocked()

Sort response items by the Locked attribute.

public NoteCategoryClient OrderByLocked()

Returns

NoteCategoryClient

OrderByLockedDescending()

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

public NoteCategoryClient OrderByLockedDescending()

Returns

NoteCategoryClient

OrderByName()

Sort response items by the Name attribute.

public NoteCategoryClient OrderByName()

Returns

NoteCategoryClient

OrderByNameDescending()

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

public NoteCategoryClient OrderByNameDescending()

Returns

NoteCategoryClient

OrderByOrganizationId()

Sort response items by the OrganizationId attribute.

public NoteCategoryClient OrderByOrganizationId()

Returns

NoteCategoryClient

OrderByOrganizationIdDescending()

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

public NoteCategoryClient OrderByOrganizationIdDescending()

Returns

NoteCategoryClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public NoteCategoryClient OrderByUpdatedAt()

Returns

NoteCategoryClient

OrderByUpdatedAtDescending()

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

public NoteCategoryClient OrderByUpdatedAtDescending()

Returns

NoteCategoryClient

PerPage(int)

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

public PaginatedNoteCategoryClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedNoteCategoryClient

The current PaginatedNoteCategoryClient instance.

PostAsync(NoteCategory, CancellationToken)

Creates a new NoteCategory resource asynchronously.

public Task<NoteCategoryResponse> PostAsync(NoteCategory resource, CancellationToken cancellationToken = default)

Parameters

resource NoteCategory

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<NoteCategoryResource>, CancellationToken)

Creates a new NoteCategory resource asynchronously.

public Task<NoteCategoryResponse> PostAsync(JsonApiDocument<NoteCategoryResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<NoteCategoryResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public NoteCategoryClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

NoteCategoryClient

WhereLocked(bool)

Query response items by the Locked attribute.

public NoteCategoryClient WhereLocked(bool value)

Parameters

value bool

Returns

NoteCategoryClient

WhereName(string)

Query response items by the Name attribute.

public NoteCategoryClient WhereName(string value)

Parameters

value string

Returns

NoteCategoryClient

WhereOrganizationId(string)

Query response items by the OrganizationId attribute.

public NoteCategoryClient WhereOrganizationId(string value)

Parameters

value string

Returns

NoteCategoryClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public NoteCategoryClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

NoteCategoryClient

WithId(string)

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

public NoteCategoryClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

NoteCategoryClient

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