Class PaginatedItemNoteClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ItemNote collection resources.

public class PaginatedItemNoteClient : PaginatedResourceClient<ItemNote, ItemNoteResource, ItemNoteCollectionResponse, ItemNoteResponse>

Inheritance

object

ResourceClient<ItemNote>

PaginatedResourceClient<ItemNote, ItemNoteResource, ItemNoteCollectionResponse, ItemNoteResponse>

PaginatedItemNoteClient

Inherited Members

PaginatedResourceClient<ItemNote, ItemNoteResource, ItemNoteCollectionResponse, ItemNoteResponse>.PerPage(int)

PaginatedResourceClient<ItemNote, ItemNoteResource, ItemNoteCollectionResponse, ItemNoteResponse>.Offset(int)

PaginatedResourceClient<ItemNote, ItemNoteResource, ItemNoteCollectionResponse, ItemNoteResponse>.Filter(string)

PaginatedResourceClient<ItemNote, ItemNoteResource, ItemNoteCollectionResponse, ItemNoteResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ItemNote, ItemNoteResource, ItemNoteCollectionResponse, ItemNoteResponse>.PostAsync(ItemNote, CancellationToken)

PaginatedResourceClient<ItemNote, ItemNoteResource, ItemNoteCollectionResponse, ItemNoteResponse>.PostAsync(JsonApiDocument<ItemNoteResource>, CancellationToken)

ResourceClient<ItemNote>.AddQueryParameter(string, string)

ResourceClient<ItemNote>.ReplaceQueryParameter(string, string)

ResourceClient<ItemNote>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ItemNote>.Uri

ResourceClient<ItemNote>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedItemNoteClient(HttpClient, Uri)

Client for interacting with ItemNote collection resources.

public PaginatedItemNoteClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedItemNoteClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedItemNoteClient

The current PaginatedItemNoteClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedItemNoteClient ClearParameters()

Returns

PaginatedItemNoteClient

The current PaginatedItemNoteClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedItemNoteClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedItemNoteClient

The current PaginatedItemNoteClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of ItemNote resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemNoteCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeItemNoteCategory()

Include related ItemNoteCategory resources in the response.

public ItemNoteClient IncludeItemNoteCategory()

Returns

ItemNoteClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedItemNoteClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedItemNoteClient

The current PaginatedItemNoteClient instance.

PerPage(int)

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

public PaginatedItemNoteClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedItemNoteClient

The current PaginatedItemNoteClient instance.

PostAsync(ItemNote, CancellationToken)

Creates a new ItemNote resource asynchronously.

public Task<ItemNoteResponse> PostAsync(ItemNote resource, CancellationToken cancellationToken = default)

Parameters

resource ItemNote

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemNoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<ItemNoteResource>, CancellationToken)

Creates a new ItemNote resource asynchronously.

public Task<ItemNoteResponse> PostAsync(JsonApiDocument<ItemNoteResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ItemNoteResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemNoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public ItemNoteClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ItemNoteClient

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