Class SignupSheetMetadataClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the SignupSheetMetadata resource.

public class SignupSheetMetadataClient : SingletonResourceClient<SignupSheetMetadata, SignupSheetMetadataResource, SignupSheetMetadataResponse>

Inheritance

object

ResourceClient<SignupSheetMetadata>

SingletonResourceClient<SignupSheetMetadata, SignupSheetMetadataResource, SignupSheetMetadataResponse>

SignupSheetMetadataClient

Inherited Members

SingletonResourceClient<SignupSheetMetadata, SignupSheetMetadataResource, SignupSheetMetadataResponse>.GetAsync(CancellationToken)

SingletonResourceClient<SignupSheetMetadata, SignupSheetMetadataResource, SignupSheetMetadataResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<SignupSheetMetadata, SignupSheetMetadataResource, SignupSheetMetadataResponse>.PatchAsync(SignupSheetMetadata, CancellationToken)

SingletonResourceClient<SignupSheetMetadata, SignupSheetMetadataResource, SignupSheetMetadataResponse>.PatchAsync(JsonApiDocument<SignupSheetMetadataResource>, CancellationToken)

SingletonResourceClient<SignupSheetMetadata, SignupSheetMetadataResource, SignupSheetMetadataResponse>.DeleteAsync(CancellationToken)

ResourceClient<SignupSheetMetadata>.AddQueryParameter(string, string)

ResourceClient<SignupSheetMetadata>.ReplaceQueryParameter(string, string)

ResourceClient<SignupSheetMetadata>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<SignupSheetMetadata>.Uri

ResourceClient<SignupSheetMetadata>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SignupSheetMetadataClient(HttpClient, Uri)

Client for interacting with the SignupSheetMetadata resource.

public SignupSheetMetadataClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public SignupSheetMetadataClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

SignupSheetMetadataClient

The current SignupSheetMetadataClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public SignupSheetMetadataClient ClearParameters()

Returns

SignupSheetMetadataClient

The current SignupSheetMetadataClient instance.

GetAsync(CancellationToken)

Fetches the SignupSheetMetadata resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SignupSheetMetadataResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.