Class PaginatedEventLabelClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with EventLabel collection resources.

public class PaginatedEventLabelClient : PaginatedResourceClient<EventLabel, EventLabelResource, EventLabelCollectionResponse, EventLabelResponse>

Inheritance

object

ResourceClient<EventLabel>

PaginatedResourceClient<EventLabel, EventLabelResource, EventLabelCollectionResponse, EventLabelResponse>

PaginatedEventLabelClient

Inherited Members

PaginatedResourceClient<EventLabel, EventLabelResource, EventLabelCollectionResponse, EventLabelResponse>.PerPage(int)

PaginatedResourceClient<EventLabel, EventLabelResource, EventLabelCollectionResponse, EventLabelResponse>.Offset(int)

PaginatedResourceClient<EventLabel, EventLabelResource, EventLabelCollectionResponse, EventLabelResponse>.Filter(string)

PaginatedResourceClient<EventLabel, EventLabelResource, EventLabelCollectionResponse, EventLabelResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<EventLabel, EventLabelResource, EventLabelCollectionResponse, EventLabelResponse>.PostAsync(EventLabel, CancellationToken)

PaginatedResourceClient<EventLabel, EventLabelResource, EventLabelCollectionResponse, EventLabelResponse>.PostAsync(JsonApiDocument<EventLabelResource>, CancellationToken)

ResourceClient<EventLabel>.AddQueryParameter(string, string)

ResourceClient<EventLabel>.ReplaceQueryParameter(string, string)

ResourceClient<EventLabel>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EventLabel>.Uri

ResourceClient<EventLabel>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedEventLabelClient(HttpClient, Uri)

Client for interacting with EventLabel collection resources.

public PaginatedEventLabelClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedEventLabelClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedEventLabelClient

The current PaginatedEventLabelClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedEventLabelClient ClearParameters()

Returns

PaginatedEventLabelClient

The current PaginatedEventLabelClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedEventLabelClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedEventLabelClient

The current PaginatedEventLabelClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of EventLabel resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventLabelCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEvent()

Include related Event resources in the response.

public EventLabelClient IncludeEvent()

Returns

EventLabelClient

IncludeLabel()

Include related Label resources in the response.

public EventLabelClient IncludeLabel()

Returns

EventLabelClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedEventLabelClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedEventLabelClient

The current PaginatedEventLabelClient instance.

PerPage(int)

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

public PaginatedEventLabelClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedEventLabelClient

The current PaginatedEventLabelClient instance.

WithId(string)

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

public EventLabelClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EventLabelClient

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