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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedDesignationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedDesignationClient

The current PaginatedDesignationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedDesignationClient ClearParameters()

Returns

PaginatedDesignationClient

The current PaginatedDesignationClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedDesignationClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedDesignationClient

The current PaginatedDesignationClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedDesignationClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedDesignationClient

The current PaginatedDesignationClient instance.

PerPage(int)

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

public PaginatedDesignationClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedDesignationClient

The current PaginatedDesignationClient instance.

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.