Class PaginatedReportTemplateClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2022_07_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ReportTemplate collection resources.

public class PaginatedReportTemplateClient : PaginatedResourceClient<ReportTemplate, ReportTemplateResource, ReportTemplateCollectionResponse, ReportTemplateResponse>

Inheritance

object

ResourceClient<ReportTemplate>

PaginatedResourceClient<ReportTemplate, ReportTemplateResource, ReportTemplateCollectionResponse, ReportTemplateResponse>

PaginatedReportTemplateClient

Inherited Members

PaginatedResourceClient<ReportTemplate, ReportTemplateResource, ReportTemplateCollectionResponse, ReportTemplateResponse>.PerPage(int)

PaginatedResourceClient<ReportTemplate, ReportTemplateResource, ReportTemplateCollectionResponse, ReportTemplateResponse>.Offset(int)

PaginatedResourceClient<ReportTemplate, ReportTemplateResource, ReportTemplateCollectionResponse, ReportTemplateResponse>.Filter(string)

PaginatedResourceClient<ReportTemplate, ReportTemplateResource, ReportTemplateCollectionResponse, ReportTemplateResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ReportTemplate, ReportTemplateResource, ReportTemplateCollectionResponse, ReportTemplateResponse>.PostAsync(ReportTemplate, CancellationToken)

PaginatedResourceClient<ReportTemplate, ReportTemplateResource, ReportTemplateCollectionResponse, ReportTemplateResponse>.PostAsync(JsonApiDocument<ReportTemplateResource>, CancellationToken)

ResourceClient<ReportTemplate>.AddQueryParameter(string, string)

ResourceClient<ReportTemplate>.ReplaceQueryParameter(string, string)

ResourceClient<ReportTemplate>.AddCustomParameter(string, string)

ResourceClient<ReportTemplate>.ClearParameters()

ResourceClient<ReportTemplate>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ReportTemplate>.Uri

ResourceClient<ReportTemplate>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedReportTemplateClient(HttpClient, Uri)

Client for interacting with ReportTemplate collection resources.

public PaginatedReportTemplateClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of ReportTemplate resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ReportTemplateCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(ReportTemplate, CancellationToken)

Creates a new ReportTemplate resource asynchronously.

public Task<ReportTemplateResponse> PostAsync(ReportTemplate resource, CancellationToken cancellationToken = default)

Parameters

resource ReportTemplate

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ReportTemplateResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<ReportTemplateResource>, CancellationToken)

Creates a new ReportTemplate resource asynchronously.

public Task<ReportTemplateResponse> PostAsync(JsonApiDocument<ReportTemplateResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ReportTemplateResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ReportTemplateResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public ReportTemplateClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ReportTemplateClient

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