Table of Contents

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
PaginatedNoteTemplateClient
Inherited Members

Constructors

PaginatedNoteTemplateClient(HttpClient, Uri)

Client for interacting with NoteTemplate collection resources.

public PaginatedNoteTemplateClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient
uri Uri

Methods

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.

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.

Edit this page