Class PaginatedNoteClient

Namespace

Crews.PlanningCenter.Api.Giving.V2019_10_18

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>.AddCustomParameter(string, string)

ResourceClient<Note>.ClearParameters()

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

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.

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.