Class PaginatedNoteTemplateClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with NoteTemplate collection resources.

public class PaginatedNoteTemplateClient : PaginatedResourceClient<NoteTemplate, NoteTemplateResource, NoteTemplateCollectionResponse, NoteTemplateResponse>

Inheritance

object

ResourceClient<NoteTemplate>

PaginatedResourceClient<NoteTemplate, NoteTemplateResource, NoteTemplateCollectionResponse, NoteTemplateResponse>

PaginatedNoteTemplateClient

Inherited Members

PaginatedResourceClient<NoteTemplate, NoteTemplateResource, NoteTemplateCollectionResponse, NoteTemplateResponse>.PerPage(int)

PaginatedResourceClient<NoteTemplate, NoteTemplateResource, NoteTemplateCollectionResponse, NoteTemplateResponse>.Offset(int)

PaginatedResourceClient<NoteTemplate, NoteTemplateResource, NoteTemplateCollectionResponse, NoteTemplateResponse>.Filter(string)

PaginatedResourceClient<NoteTemplate, NoteTemplateResource, NoteTemplateCollectionResponse, NoteTemplateResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<NoteTemplate, NoteTemplateResource, NoteTemplateCollectionResponse, NoteTemplateResponse>.PostAsync(NoteTemplate, CancellationToken)

PaginatedResourceClient<NoteTemplate, NoteTemplateResource, NoteTemplateCollectionResponse, NoteTemplateResponse>.PostAsync(JsonApiDocument<NoteTemplateResource>, CancellationToken)

ResourceClient<NoteTemplate>.AddQueryParameter(string, string)

ResourceClient<NoteTemplate>.ReplaceQueryParameter(string, string)

ResourceClient<NoteTemplate>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<NoteTemplate>.Uri

ResourceClient<NoteTemplate>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedNoteTemplateClient(HttpClient, Uri)

Client for interacting with NoteTemplate collection resources.

public PaginatedNoteTemplateClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedNoteTemplateClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedNoteTemplateClient

The current PaginatedNoteTemplateClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedNoteTemplateClient ClearParameters()

Returns

PaginatedNoteTemplateClient

The current PaginatedNoteTemplateClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedNoteTemplateClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedNoteTemplateClient

The current PaginatedNoteTemplateClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of NoteTemplate resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteTemplateCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedNoteTemplateClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedNoteTemplateClient

The current PaginatedNoteTemplateClient instance.

PerPage(int)

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

public PaginatedNoteTemplateClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedNoteTemplateClient

The current PaginatedNoteTemplateClient instance.

WithId(string)

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

public NoteTemplateClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

NoteTemplateClient

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