Class PaginatedEventNoteClient

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with EventNote collection resources.

public class PaginatedEventNoteClient : PaginatedResourceClient<EventNote, EventNoteResource, EventNoteCollectionResponse, EventNoteResponse>

Inheritance

object

ResourceClient<EventNote>

PaginatedResourceClient<EventNote, EventNoteResource, EventNoteCollectionResponse, EventNoteResponse>

PaginatedEventNoteClient

Inherited Members

PaginatedResourceClient<EventNote, EventNoteResource, EventNoteCollectionResponse, EventNoteResponse>.PerPage(int)

PaginatedResourceClient<EventNote, EventNoteResource, EventNoteCollectionResponse, EventNoteResponse>.Offset(int)

PaginatedResourceClient<EventNote, EventNoteResource, EventNoteCollectionResponse, EventNoteResponse>.Filter(string)

PaginatedResourceClient<EventNote, EventNoteResource, EventNoteCollectionResponse, EventNoteResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<EventNote, EventNoteResource, EventNoteCollectionResponse, EventNoteResponse>.PostAsync(EventNote, CancellationToken)

PaginatedResourceClient<EventNote, EventNoteResource, EventNoteCollectionResponse, EventNoteResponse>.PostAsync(JsonApiDocument<EventNoteResource>, CancellationToken)

ResourceClient<EventNote>.AddQueryParameter(string, string)

ResourceClient<EventNote>.ReplaceQueryParameter(string, string)

ResourceClient<EventNote>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EventNote>.Uri

ResourceClient<EventNote>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedEventNoteClient(HttpClient, Uri)

Client for interacting with EventNote collection resources.

public PaginatedEventNoteClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedEventNoteClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedEventNoteClient

The current PaginatedEventNoteClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedEventNoteClient ClearParameters()

Returns

PaginatedEventNoteClient

The current PaginatedEventNoteClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedEventNoteClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedEventNoteClient

The current PaginatedEventNoteClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of EventNote resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventNoteCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeOwner()

Include related Owner resources in the response.

public EventNoteClient IncludeOwner()

Returns

EventNoteClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedEventNoteClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedEventNoteClient

The current PaginatedEventNoteClient instance.

PerPage(int)

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

public PaginatedEventNoteClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedEventNoteClient

The current PaginatedEventNoteClient instance.

WithId(string)

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

public EventNoteClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EventNoteClient

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