Class PaginatedEventConnectionClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2022_07_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with EventConnection collection resources.

public class PaginatedEventConnectionClient : PaginatedResourceClient<EventConnection, EventConnectionResource, EventConnectionCollectionResponse, EventConnectionResponse>

Inheritance

object

ResourceClient<EventConnection>

PaginatedResourceClient<EventConnection, EventConnectionResource, EventConnectionCollectionResponse, EventConnectionResponse>

PaginatedEventConnectionClient

Inherited Members

PaginatedResourceClient<EventConnection, EventConnectionResource, EventConnectionCollectionResponse, EventConnectionResponse>.PerPage(int)

PaginatedResourceClient<EventConnection, EventConnectionResource, EventConnectionCollectionResponse, EventConnectionResponse>.Offset(int)

PaginatedResourceClient<EventConnection, EventConnectionResource, EventConnectionCollectionResponse, EventConnectionResponse>.Filter(string)

PaginatedResourceClient<EventConnection, EventConnectionResource, EventConnectionCollectionResponse, EventConnectionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<EventConnection, EventConnectionResource, EventConnectionCollectionResponse, EventConnectionResponse>.PostAsync(EventConnection, CancellationToken)

PaginatedResourceClient<EventConnection, EventConnectionResource, EventConnectionCollectionResponse, EventConnectionResponse>.PostAsync(JsonApiDocument<EventConnectionResource>, CancellationToken)

ResourceClient<EventConnection>.AddQueryParameter(string, string)

ResourceClient<EventConnection>.ReplaceQueryParameter(string, string)

ResourceClient<EventConnection>.AddCustomParameter(string, string)

ResourceClient<EventConnection>.ClearParameters()

ResourceClient<EventConnection>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EventConnection>.Uri

ResourceClient<EventConnection>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedEventConnectionClient(HttpClient, Uri)

Client for interacting with EventConnection collection resources.

public PaginatedEventConnectionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of EventConnection resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventConnectionCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(EventConnection, CancellationToken)

Creates a new EventConnection resource asynchronously.

public Task<EventConnectionResponse> PostAsync(EventConnection resource, CancellationToken cancellationToken = default)

Parameters

resource EventConnection

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventConnectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<EventConnectionResource>, CancellationToken)

Creates a new EventConnection resource asynchronously.

public Task<EventConnectionResponse> PostAsync(JsonApiDocument<EventConnectionResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<EventConnectionResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventConnectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereConnectedToId(string)

Query response items by the ConnectedToId attribute.

public EventConnectionClient WhereConnectedToId(string value)

Parameters

value string

Returns

EventConnectionClient

WhereProductName(string)

Query response items by the ProductName attribute.

public EventConnectionClient WhereProductName(string value)

Parameters

value string

Returns

EventConnectionClient

WherePromoted(bool)

Query response items by the Promoted attribute.

public EventConnectionClient WherePromoted(bool value)

Parameters

value bool

Returns

EventConnectionClient

WithId(string)

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

public EventConnectionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EventConnectionClient

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