Class PaginatedLabelClient

Namespace

Crews.PlanningCenter.Api.Giving.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Label collection resources.

public class PaginatedLabelClient : PaginatedResourceClient<Label, LabelResource, LabelCollectionResponse, LabelResponse>

Inheritance

object

ResourceClient<Label>

PaginatedResourceClient<Label, LabelResource, LabelCollectionResponse, LabelResponse>

PaginatedLabelClient

Inherited Members

PaginatedResourceClient<Label, LabelResource, LabelCollectionResponse, LabelResponse>.PerPage(int)

PaginatedResourceClient<Label, LabelResource, LabelCollectionResponse, LabelResponse>.Offset(int)

PaginatedResourceClient<Label, LabelResource, LabelCollectionResponse, LabelResponse>.Filter(string)

PaginatedResourceClient<Label, LabelResource, LabelCollectionResponse, LabelResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Label, LabelResource, LabelCollectionResponse, LabelResponse>.PostAsync(Label, CancellationToken)

PaginatedResourceClient<Label, LabelResource, LabelCollectionResponse, LabelResponse>.PostAsync(JsonApiDocument<LabelResource>, CancellationToken)

ResourceClient<Label>.AddQueryParameter(string, string)

ResourceClient<Label>.ReplaceQueryParameter(string, string)

ResourceClient<Label>.AddCustomParameter(string, string)

ResourceClient<Label>.ClearParameters()

ResourceClient<Label>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Label>.Uri

ResourceClient<Label>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedLabelClient(HttpClient, Uri)

Client for interacting with Label collection resources.

public PaginatedLabelClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Label resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LabelCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(Label, CancellationToken)

Creates a new Label resource asynchronously.

public Task<LabelResponse> PostAsync(Label resource, CancellationToken cancellationToken = default)

Parameters

resource Label

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LabelResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<LabelResource>, CancellationToken)

Creates a new Label resource asynchronously.

public Task<LabelResponse> PostAsync(JsonApiDocument<LabelResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<LabelResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LabelResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereSlug(string)

Query response items by the Slug attribute.

public LabelClient WhereSlug(string value)

Parameters

value string

Returns

LabelClient

WithId(string)

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

public LabelClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

LabelClient

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