Class SignupSheetClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the SignupSheet resource.

public class SignupSheetClient : SingletonResourceClient<SignupSheet, SignupSheetResource, SignupSheetResponse>

Inheritance

object

ResourceClient<SignupSheet>

SingletonResourceClient<SignupSheet, SignupSheetResource, SignupSheetResponse>

SignupSheetClient

Inherited Members

SingletonResourceClient<SignupSheet, SignupSheetResource, SignupSheetResponse>.GetAsync(CancellationToken)

SingletonResourceClient<SignupSheet, SignupSheetResource, SignupSheetResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<SignupSheet, SignupSheetResource, SignupSheetResponse>.PatchAsync(SignupSheet, CancellationToken)

SingletonResourceClient<SignupSheet, SignupSheetResource, SignupSheetResponse>.PatchAsync(JsonApiDocument<SignupSheetResource>, CancellationToken)

SingletonResourceClient<SignupSheet, SignupSheetResource, SignupSheetResponse>.DeleteAsync(CancellationToken)

ResourceClient<SignupSheet>.AddQueryParameter(string, string)

ResourceClient<SignupSheet>.ReplaceQueryParameter(string, string)

ResourceClient<SignupSheet>.AddCustomParameter(string, string)

ResourceClient<SignupSheet>.ClearParameters()

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

SignupSheetClient(HttpClient, Uri)

Client for interacting with the SignupSheet resource.

public SignupSheetClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

ScheduledPeople

Associated ScheduledPeople.

public PaginatedScheduledPersonClient ScheduledPeople { get; }

Property Value

PaginatedScheduledPersonClient

SignupSheetMetadata

Associated SignupSheetMetadata.

public PaginatedSignupSheetMetadataClient SignupSheetMetadata { get; }

Property Value

PaginatedSignupSheetMetadataClient

Methods

AcceptAsync(CancellationToken)

Accept a signup sheet

public Task AcceptAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

GetAsync(CancellationToken)

Fetches the SignupSheet resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SignupSheetResponse>

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

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