Class EventConnectionClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the EventConnection resource.

public class EventConnectionClient : SingletonResourceClient<EventConnection, EventConnectionResource, EventConnectionResponse>

Inheritance

object

ResourceClient<EventConnection>

SingletonResourceClient<EventConnection, EventConnectionResource, EventConnectionResponse>

EventConnectionClient

Inherited Members

SingletonResourceClient<EventConnection, EventConnectionResource, EventConnectionResponse>.GetAsync(CancellationToken)

SingletonResourceClient<EventConnection, EventConnectionResource, EventConnectionResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<EventConnection, EventConnectionResource, EventConnectionResponse>.PatchAsync(EventConnection, CancellationToken)

SingletonResourceClient<EventConnection, EventConnectionResource, EventConnectionResponse>.PatchAsync(JsonApiDocument<EventConnectionResource>, CancellationToken)

SingletonResourceClient<EventConnection, EventConnectionResource, EventConnectionResponse>.DeleteAsync(CancellationToken)

ResourceClient<EventConnection>.AddQueryParameter(string, string)

ResourceClient<EventConnection>.ReplaceQueryParameter(string, string)

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

EventConnectionClient(HttpClient, Uri)

Client for interacting with the EventConnection resource.

public EventConnectionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public EventConnectionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

EventConnectionClient

The current EventConnectionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public EventConnectionClient ClearParameters()

Returns

EventConnectionClient

The current EventConnectionClient instance.

DeleteAsync(CancellationToken)

Deletes the EventConnection resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the EventConnection resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventConnectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(EventConnection, CancellationToken)

Updates an existing EventConnection resource asynchronously.

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

Parameters

resource EventConnection

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventConnectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<EventConnectionResource>, CancellationToken)

Updates an existing EventConnection resource asynchronously.

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

Parameters

document JsonApiDocument<EventConnectionResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventConnectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.