Class PaginatedPlanNoteClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PlanNote collection resources.

public class PaginatedPlanNoteClient : PaginatedResourceClient<PlanNote, PlanNoteResource, PlanNoteCollectionResponse, PlanNoteResponse>

Inheritance

object

ResourceClient<PlanNote>

PaginatedResourceClient<PlanNote, PlanNoteResource, PlanNoteCollectionResponse, PlanNoteResponse>

PaginatedPlanNoteClient

Inherited Members

PaginatedResourceClient<PlanNote, PlanNoteResource, PlanNoteCollectionResponse, PlanNoteResponse>.PerPage(int)

PaginatedResourceClient<PlanNote, PlanNoteResource, PlanNoteCollectionResponse, PlanNoteResponse>.Offset(int)

PaginatedResourceClient<PlanNote, PlanNoteResource, PlanNoteCollectionResponse, PlanNoteResponse>.Filter(string)

PaginatedResourceClient<PlanNote, PlanNoteResource, PlanNoteCollectionResponse, PlanNoteResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PlanNote, PlanNoteResource, PlanNoteCollectionResponse, PlanNoteResponse>.PostAsync(PlanNote, CancellationToken)

PaginatedResourceClient<PlanNote, PlanNoteResource, PlanNoteCollectionResponse, PlanNoteResponse>.PostAsync(JsonApiDocument<PlanNoteResource>, CancellationToken)

ResourceClient<PlanNote>.AddQueryParameter(string, string)

ResourceClient<PlanNote>.ReplaceQueryParameter(string, string)

ResourceClient<PlanNote>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PlanNote>.Uri

ResourceClient<PlanNote>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPlanNoteClient(HttpClient, Uri)

Client for interacting with PlanNote collection resources.

public PaginatedPlanNoteClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPlanNoteClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPlanNoteClient

The current PaginatedPlanNoteClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPlanNoteClient ClearParameters()

Returns

PaginatedPlanNoteClient

The current PaginatedPlanNoteClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPlanNoteClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPlanNoteClient

The current PaginatedPlanNoteClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of PlanNote resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanNoteCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePlanNoteCategory()

Include related PlanNoteCategory resources in the response.

public PlanNoteClient IncludePlanNoteCategory()

Returns

PlanNoteClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPlanNoteClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPlanNoteClient

The current PaginatedPlanNoteClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public PlanNoteClient OrderByCreatedAt()

Returns

PlanNoteClient

OrderByCreatedAtDescending()

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

public PlanNoteClient OrderByCreatedAtDescending()

Returns

PlanNoteClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public PlanNoteClient OrderByUpdatedAt()

Returns

PlanNoteClient

OrderByUpdatedAtDescending()

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

public PlanNoteClient OrderByUpdatedAtDescending()

Returns

PlanNoteClient

PerPage(int)

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

public PaginatedPlanNoteClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPlanNoteClient

The current PaginatedPlanNoteClient instance.

PostAsync(PlanNote, CancellationToken)

Creates a new PlanNote resource asynchronously.

public Task<PlanNoteResponse> PostAsync(PlanNote resource, CancellationToken cancellationToken = default)

Parameters

resource PlanNote

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanNoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<PlanNoteResource>, CancellationToken)

Creates a new PlanNote resource asynchronously.

public Task<PlanNoteResponse> PostAsync(JsonApiDocument<PlanNoteResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<PlanNoteResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanNoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public PlanNoteClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

PlanNoteClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public PlanNoteClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

PlanNoteClient

WithId(string)

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

public PlanNoteClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PlanNoteClient

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