Class PaginatedSignupSheetMetadataClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with SignupSheetMetadata collection resources.

public class PaginatedSignupSheetMetadataClient : PaginatedResourceClient<SignupSheetMetadata, SignupSheetMetadataResource, SignupSheetMetadataCollectionResponse, SignupSheetMetadataResponse>

Inheritance

object

ResourceClient<SignupSheetMetadata>

PaginatedResourceClient<SignupSheetMetadata, SignupSheetMetadataResource, SignupSheetMetadataCollectionResponse, SignupSheetMetadataResponse>

PaginatedSignupSheetMetadataClient

Inherited Members

PaginatedResourceClient<SignupSheetMetadata, SignupSheetMetadataResource, SignupSheetMetadataCollectionResponse, SignupSheetMetadataResponse>.PerPage(int)

PaginatedResourceClient<SignupSheetMetadata, SignupSheetMetadataResource, SignupSheetMetadataCollectionResponse, SignupSheetMetadataResponse>.Offset(int)

PaginatedResourceClient<SignupSheetMetadata, SignupSheetMetadataResource, SignupSheetMetadataCollectionResponse, SignupSheetMetadataResponse>.Filter(string)

PaginatedResourceClient<SignupSheetMetadata, SignupSheetMetadataResource, SignupSheetMetadataCollectionResponse, SignupSheetMetadataResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<SignupSheetMetadata, SignupSheetMetadataResource, SignupSheetMetadataCollectionResponse, SignupSheetMetadataResponse>.PostAsync(SignupSheetMetadata, CancellationToken)

PaginatedResourceClient<SignupSheetMetadata, SignupSheetMetadataResource, SignupSheetMetadataCollectionResponse, SignupSheetMetadataResponse>.PostAsync(JsonApiDocument<SignupSheetMetadataResource>, CancellationToken)

ResourceClient<SignupSheetMetadata>.AddQueryParameter(string, string)

ResourceClient<SignupSheetMetadata>.ReplaceQueryParameter(string, string)

ResourceClient<SignupSheetMetadata>.AddCustomParameter(string, string)

ResourceClient<SignupSheetMetadata>.ClearParameters()

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

PaginatedSignupSheetMetadataClient(HttpClient, Uri)

Client for interacting with SignupSheetMetadata collection resources.

public PaginatedSignupSheetMetadataClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of SignupSheetMetadata resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SignupSheetMetadataCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.