Class PaginatedAvailableSignupClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with AvailableSignup collection resources.

public class PaginatedAvailableSignupClient : PaginatedResourceClient<AvailableSignup, AvailableSignupResource, AvailableSignupCollectionResponse, AvailableSignupResponse>

Inheritance

object

ResourceClient<AvailableSignup>

PaginatedResourceClient<AvailableSignup, AvailableSignupResource, AvailableSignupCollectionResponse, AvailableSignupResponse>

PaginatedAvailableSignupClient

Inherited Members

PaginatedResourceClient<AvailableSignup, AvailableSignupResource, AvailableSignupCollectionResponse, AvailableSignupResponse>.PerPage(int)

PaginatedResourceClient<AvailableSignup, AvailableSignupResource, AvailableSignupCollectionResponse, AvailableSignupResponse>.Offset(int)

PaginatedResourceClient<AvailableSignup, AvailableSignupResource, AvailableSignupCollectionResponse, AvailableSignupResponse>.Filter(string)

PaginatedResourceClient<AvailableSignup, AvailableSignupResource, AvailableSignupCollectionResponse, AvailableSignupResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<AvailableSignup, AvailableSignupResource, AvailableSignupCollectionResponse, AvailableSignupResponse>.PostAsync(AvailableSignup, CancellationToken)

PaginatedResourceClient<AvailableSignup, AvailableSignupResource, AvailableSignupCollectionResponse, AvailableSignupResponse>.PostAsync(JsonApiDocument<AvailableSignupResource>, CancellationToken)

ResourceClient<AvailableSignup>.AddQueryParameter(string, string)

ResourceClient<AvailableSignup>.ReplaceQueryParameter(string, string)

ResourceClient<AvailableSignup>.AddCustomParameter(string, string)

ResourceClient<AvailableSignup>.ClearParameters()

ResourceClient<AvailableSignup>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<AvailableSignup>.Uri

ResourceClient<AvailableSignup>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedAvailableSignupClient(HttpClient, Uri)

Client for interacting with AvailableSignup collection resources.

public PaginatedAvailableSignupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of AvailableSignup resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AvailableSignupCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeSignupSheets()

Include related SignupSheets resources in the response.

public AvailableSignupClient IncludeSignupSheets()

Returns

AvailableSignupClient

WithId(string)

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

public AvailableSignupClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

AvailableSignupClient

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