Class PaginatedSignupSheetMetadataClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedSignupSheetMetadataClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedSignupSheetMetadataClient

The current PaginatedSignupSheetMetadataClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedSignupSheetMetadataClient ClearParameters()

Returns

PaginatedSignupSheetMetadataClient

The current PaginatedSignupSheetMetadataClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedSignupSheetMetadataClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedSignupSheetMetadataClient

The current PaginatedSignupSheetMetadataClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedSignupSheetMetadataClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedSignupSheetMetadataClient

The current PaginatedSignupSheetMetadataClient instance.

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedSignupSheetMetadataClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedSignupSheetMetadataClient

The current PaginatedSignupSheetMetadataClient instance.