Class EventLabelClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2025_05_28

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the EventLabel resource.

public class EventLabelClient : SingletonResourceClient<EventLabel, EventLabelResource, EventLabelResponse>

Inheritance

object

ResourceClient<EventLabel>

SingletonResourceClient<EventLabel, EventLabelResource, EventLabelResponse>

EventLabelClient

Inherited Members

SingletonResourceClient<EventLabel, EventLabelResource, EventLabelResponse>.GetAsync(CancellationToken)

SingletonResourceClient<EventLabel, EventLabelResource, EventLabelResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<EventLabel, EventLabelResource, EventLabelResponse>.PatchAsync(EventLabel, CancellationToken)

SingletonResourceClient<EventLabel, EventLabelResource, EventLabelResponse>.PatchAsync(JsonApiDocument<EventLabelResource>, CancellationToken)

SingletonResourceClient<EventLabel, EventLabelResource, EventLabelResponse>.DeleteAsync(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

EventLabelClient(HttpClient, Uri)

Client for interacting with the EventLabel resource.

public EventLabelClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Event

Associated Event.

public EventClient Event { get; }

Property Value

EventClient

Label

Associated Label.

public LabelClient Label { get; }

Property Value

LabelClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public EventLabelClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

EventLabelClient

The current EventLabelClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public EventLabelClient ClearParameters()

Returns

EventLabelClient

The current EventLabelClient instance.

GetAsync(CancellationToken)

Fetches the EventLabel resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventLabelResponse>

A task representing the asynchronous operation, containing the EventLabel resource.

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