Class AvailableSignupClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the AvailableSignup resource.

public class AvailableSignupClient : SingletonResourceClient<AvailableSignup, AvailableSignupResource, AvailableSignupResponse>

Inheritance

object

ResourceClient<AvailableSignup>

SingletonResourceClient<AvailableSignup, AvailableSignupResource, AvailableSignupResponse>

AvailableSignupClient

Inherited Members

SingletonResourceClient<AvailableSignup, AvailableSignupResource, AvailableSignupResponse>.GetAsync(CancellationToken)

SingletonResourceClient<AvailableSignup, AvailableSignupResource, AvailableSignupResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<AvailableSignup, AvailableSignupResource, AvailableSignupResponse>.PatchAsync(AvailableSignup, CancellationToken)

SingletonResourceClient<AvailableSignup, AvailableSignupResource, AvailableSignupResponse>.PatchAsync(JsonApiDocument<AvailableSignupResource>, CancellationToken)

SingletonResourceClient<AvailableSignup, AvailableSignupResource, AvailableSignupResponse>.DeleteAsync(CancellationToken)

ResourceClient<AvailableSignup>.AddQueryParameter(string, string)

ResourceClient<AvailableSignup>.ReplaceQueryParameter(string, string)

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

AvailableSignupClient(HttpClient, Uri)

Client for interacting with the AvailableSignup resource.

public AvailableSignupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

SignupSheets

Associated SignupSheets.

public PaginatedSignupSheetClient SignupSheets { get; }

Property Value

PaginatedSignupSheetClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public AvailableSignupClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

AvailableSignupClient

The current AvailableSignupClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public AvailableSignupClient ClearParameters()

Returns

AvailableSignupClient

The current AvailableSignupClient instance.

GetAsync(CancellationToken)

Fetches the AvailableSignup resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AvailableSignupResponse>

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

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