Class PaginatedGradeClient

Namespace

Crews.PlanningCenter.Api.People.V2025_11_10

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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedGradeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedGradeClient

The current PaginatedGradeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedGradeClient ClearParameters()

Returns

PaginatedGradeClient

The current PaginatedGradeClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedGradeClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedGradeClient

The current PaginatedGradeClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedGradeClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedGradeClient

The current PaginatedGradeClient instance.

PerPage(int)

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

public PaginatedGradeClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedGradeClient

The current PaginatedGradeClient instance.