Class PaginatedRsvpClient

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Rsvp collection resources.

public class PaginatedRsvpClient : PaginatedResourceClient<Rsvp, RsvpResource, RsvpCollectionResponse, RsvpResponse>

Inheritance

object

ResourceClient<Rsvp>

PaginatedResourceClient<Rsvp, RsvpResource, RsvpCollectionResponse, RsvpResponse>

PaginatedRsvpClient

Inherited Members

PaginatedResourceClient<Rsvp, RsvpResource, RsvpCollectionResponse, RsvpResponse>.PerPage(int)

PaginatedResourceClient<Rsvp, RsvpResource, RsvpCollectionResponse, RsvpResponse>.Offset(int)

PaginatedResourceClient<Rsvp, RsvpResource, RsvpCollectionResponse, RsvpResponse>.Filter(string)

PaginatedResourceClient<Rsvp, RsvpResource, RsvpCollectionResponse, RsvpResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Rsvp, RsvpResource, RsvpCollectionResponse, RsvpResponse>.PostAsync(Rsvp, CancellationToken)

PaginatedResourceClient<Rsvp, RsvpResource, RsvpCollectionResponse, RsvpResponse>.PostAsync(JsonApiDocument<RsvpResource>, CancellationToken)

ResourceClient<Rsvp>.AddQueryParameter(string, string)

ResourceClient<Rsvp>.ReplaceQueryParameter(string, string)

ResourceClient<Rsvp>.AddCustomParameter(string, string)

ResourceClient<Rsvp>.ClearParameters()

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

PaginatedRsvpClient(HttpClient, Uri)

Client for interacting with Rsvp collection resources.

public PaginatedRsvpClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Rsvp resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RsvpCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderByResponse()

Sort response items by the Response attribute.

public RsvpClient OrderByResponse()

Returns

RsvpClient

OrderByResponseDescending()

Sort response items by the Response attribute. Use reverse order.

public RsvpClient OrderByResponseDescending()

Returns

RsvpClient

WhereResponse(string)

Query response items by the Response attribute.

public RsvpClient WhereResponse(string value)

Parameters

value string

Returns

RsvpClient