Class PaginatedDesignationClient

Namespace

Crews.PlanningCenter.Api.Giving.V2019_10_18

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Designation collection resources.

public class PaginatedDesignationClient : PaginatedResourceClient<Designation, DesignationResource, DesignationCollectionResponse, DesignationResponse>

Inheritance

object

ResourceClient<Designation>

PaginatedResourceClient<Designation, DesignationResource, DesignationCollectionResponse, DesignationResponse>

PaginatedDesignationClient

Inherited Members

PaginatedResourceClient<Designation, DesignationResource, DesignationCollectionResponse, DesignationResponse>.PerPage(int)

PaginatedResourceClient<Designation, DesignationResource, DesignationCollectionResponse, DesignationResponse>.Offset(int)

PaginatedResourceClient<Designation, DesignationResource, DesignationCollectionResponse, DesignationResponse>.Filter(string)

PaginatedResourceClient<Designation, DesignationResource, DesignationCollectionResponse, DesignationResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Designation, DesignationResource, DesignationCollectionResponse, DesignationResponse>.PostAsync(Designation, CancellationToken)

PaginatedResourceClient<Designation, DesignationResource, DesignationCollectionResponse, DesignationResponse>.PostAsync(JsonApiDocument<DesignationResource>, CancellationToken)

ResourceClient<Designation>.AddQueryParameter(string, string)

ResourceClient<Designation>.ReplaceQueryParameter(string, string)

ResourceClient<Designation>.AddCustomParameter(string, string)

ResourceClient<Designation>.ClearParameters()

ResourceClient<Designation>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Designation>.Uri

ResourceClient<Designation>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedDesignationClient(HttpClient, Uri)

Client for interacting with Designation collection resources.

public PaginatedDesignationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Designation resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<DesignationCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public DesignationClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

DesignationClient

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