Class PaginatedSignupSheetClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with SignupSheet collection resources.

public class PaginatedSignupSheetClient : PaginatedResourceClient<SignupSheet, SignupSheetResource, SignupSheetCollectionResponse, SignupSheetResponse>

Inheritance

object

ResourceClient<SignupSheet>

PaginatedResourceClient<SignupSheet, SignupSheetResource, SignupSheetCollectionResponse, SignupSheetResponse>

PaginatedSignupSheetClient

Inherited Members

PaginatedResourceClient<SignupSheet, SignupSheetResource, SignupSheetCollectionResponse, SignupSheetResponse>.PerPage(int)

PaginatedResourceClient<SignupSheet, SignupSheetResource, SignupSheetCollectionResponse, SignupSheetResponse>.Offset(int)

PaginatedResourceClient<SignupSheet, SignupSheetResource, SignupSheetCollectionResponse, SignupSheetResponse>.Filter(string)

PaginatedResourceClient<SignupSheet, SignupSheetResource, SignupSheetCollectionResponse, SignupSheetResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<SignupSheet, SignupSheetResource, SignupSheetCollectionResponse, SignupSheetResponse>.PostAsync(SignupSheet, CancellationToken)

PaginatedResourceClient<SignupSheet, SignupSheetResource, SignupSheetCollectionResponse, SignupSheetResponse>.PostAsync(JsonApiDocument<SignupSheetResource>, CancellationToken)

ResourceClient<SignupSheet>.AddQueryParameter(string, string)

ResourceClient<SignupSheet>.ReplaceQueryParameter(string, string)

ResourceClient<SignupSheet>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<SignupSheet>.Uri

ResourceClient<SignupSheet>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedSignupSheetClient(HttpClient, Uri)

Client for interacting with SignupSheet collection resources.

public PaginatedSignupSheetClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedSignupSheetClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedSignupSheetClient

The current PaginatedSignupSheetClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedSignupSheetClient ClearParameters()

Returns

PaginatedSignupSheetClient

The current PaginatedSignupSheetClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedSignupSheetClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedSignupSheetClient

The current PaginatedSignupSheetClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of SignupSheet resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SignupSheetCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeScheduledPeople()

Include related ScheduledPeople resources in the response.

public SignupSheetClient IncludeScheduledPeople()

Returns

SignupSheetClient

IncludeSignupSheetMetadata()

Include related SignupSheetMetadata resources in the response.

public SignupSheetClient IncludeSignupSheetMetadata()

Returns

SignupSheetClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedSignupSheetClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedSignupSheetClient

The current PaginatedSignupSheetClient instance.

PerPage(int)

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

public PaginatedSignupSheetClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedSignupSheetClient

The current PaginatedSignupSheetClient instance.

WithId(string)

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

public SignupSheetClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SignupSheetClient

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