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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedRsvpClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedRsvpClient

The current PaginatedRsvpClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedRsvpClient ClearParameters()

Returns

PaginatedRsvpClient

The current PaginatedRsvpClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedRsvpClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedRsvpClient

The current PaginatedRsvpClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedRsvpClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedRsvpClient

The current PaginatedRsvpClient instance.

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

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedRsvpClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedRsvpClient

The current PaginatedRsvpClient instance.

WhereResponse(string)

Query response items by the Response attribute.

public RsvpClient WhereResponse(string value)

Parameters

value string

Returns

RsvpClient