Class RsvpClient

Namespace

Crews.PlanningCenter.Api.Groups.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Rsvp resource.

public class RsvpClient : SingletonResourceClient<Rsvp, RsvpResource, RsvpResponse>

Inheritance

object

ResourceClient<Rsvp>

SingletonResourceClient<Rsvp, RsvpResource, RsvpResponse>

RsvpClient

Inherited Members

SingletonResourceClient<Rsvp, RsvpResource, RsvpResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Rsvp, RsvpResource, RsvpResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Rsvp, RsvpResource, RsvpResponse>.PatchAsync(Rsvp, CancellationToken)

SingletonResourceClient<Rsvp, RsvpResource, RsvpResponse>.PatchAsync(JsonApiDocument<RsvpResource>, CancellationToken)

SingletonResourceClient<Rsvp, RsvpResource, RsvpResponse>.DeleteAsync(CancellationToken)

ResourceClient<Rsvp>.AddQueryParameter(string, string)

ResourceClient<Rsvp>.ReplaceQueryParameter(string, string)

ResourceClient<Rsvp>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Rsvp>.Uri

ResourceClient<Rsvp>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

RsvpClient(HttpClient, Uri)

Client for interacting with the Rsvp resource.

public RsvpClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public RsvpClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

RsvpClient

The current RsvpClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public RsvpClient ClearParameters()

Returns

RsvpClient

The current RsvpClient instance.

GetAsync(CancellationToken)

Fetches the Rsvp resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RsvpResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.