Class PaginatedNoteClient

Namespace

Crews.PlanningCenter.Api.Giving.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Note collection resources.

public class PaginatedNoteClient : PaginatedResourceClient<Note, NoteResource, NoteCollectionResponse, NoteResponse>

Inheritance

object

ResourceClient<Note>

PaginatedResourceClient<Note, NoteResource, NoteCollectionResponse, NoteResponse>

PaginatedNoteClient

Inherited Members

PaginatedResourceClient<Note, NoteResource, NoteCollectionResponse, NoteResponse>.PerPage(int)

PaginatedResourceClient<Note, NoteResource, NoteCollectionResponse, NoteResponse>.Offset(int)

PaginatedResourceClient<Note, NoteResource, NoteCollectionResponse, NoteResponse>.Filter(string)

PaginatedResourceClient<Note, NoteResource, NoteCollectionResponse, NoteResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Note, NoteResource, NoteCollectionResponse, NoteResponse>.PostAsync(Note, CancellationToken)

PaginatedResourceClient<Note, NoteResource, NoteCollectionResponse, NoteResponse>.PostAsync(JsonApiDocument<NoteResource>, CancellationToken)

ResourceClient<Note>.AddQueryParameter(string, string)

ResourceClient<Note>.ReplaceQueryParameter(string, string)

ResourceClient<Note>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Note>.Uri

ResourceClient<Note>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedNoteClient(HttpClient, Uri)

Client for interacting with Note collection resources.

public PaginatedNoteClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedNoteClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedNoteClient

The current PaginatedNoteClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedNoteClient ClearParameters()

Returns

PaginatedNoteClient

The current PaginatedNoteClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedNoteClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedNoteClient

The current PaginatedNoteClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Note resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedNoteClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedNoteClient

The current PaginatedNoteClient instance.

PerPage(int)

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

public PaginatedNoteClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedNoteClient

The current PaginatedNoteClient instance.

PostAsync(Note, CancellationToken)

Creates a new Note resource asynchronously.

public Task<NoteResponse> PostAsync(Note resource, CancellationToken cancellationToken = default)

Parameters

resource Note

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<NoteResource>, CancellationToken)

Creates a new Note resource asynchronously.

public Task<NoteResponse> PostAsync(JsonApiDocument<NoteResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<NoteResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public NoteClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

NoteClient

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