Class PaginatedGradeClient

Namespace

Crews.PlanningCenter.Api.People.V2025_07_17

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Grade collection resources.

public class PaginatedGradeClient : PaginatedResourceClient<Grade, GradeResource, GradeCollectionResponse, GradeResponse>

Inheritance

object

ResourceClient<Grade>

PaginatedResourceClient<Grade, GradeResource, GradeCollectionResponse, GradeResponse>

PaginatedGradeClient

Inherited Members

PaginatedResourceClient<Grade, GradeResource, GradeCollectionResponse, GradeResponse>.PerPage(int)

PaginatedResourceClient<Grade, GradeResource, GradeCollectionResponse, GradeResponse>.Offset(int)

PaginatedResourceClient<Grade, GradeResource, GradeCollectionResponse, GradeResponse>.Filter(string)

PaginatedResourceClient<Grade, GradeResource, GradeCollectionResponse, GradeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Grade, GradeResource, GradeCollectionResponse, GradeResponse>.PostAsync(Grade, CancellationToken)

PaginatedResourceClient<Grade, GradeResource, GradeCollectionResponse, GradeResponse>.PostAsync(JsonApiDocument<GradeResource>, CancellationToken)

ResourceClient<Grade>.AddQueryParameter(string, string)

ResourceClient<Grade>.ReplaceQueryParameter(string, string)

ResourceClient<Grade>.AddCustomParameter(string, string)

ResourceClient<Grade>.ClearParameters()

ResourceClient<Grade>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Grade>.Uri

ResourceClient<Grade>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedGradeClient(HttpClient, Uri)

Client for interacting with Grade collection resources.

public PaginatedGradeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Grade resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<GradeCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.