Class PaginatedFormSubmissionValueClient

Namespace

Crews.PlanningCenter.Api.People.V2020_07_22

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with FormSubmissionValue collection resources.

public class PaginatedFormSubmissionValueClient : PaginatedResourceClient<FormSubmissionValue, FormSubmissionValueResource, FormSubmissionValueCollectionResponse, FormSubmissionValueResponse>

Inheritance

object

ResourceClient<FormSubmissionValue>

PaginatedResourceClient<FormSubmissionValue, FormSubmissionValueResource, FormSubmissionValueCollectionResponse, FormSubmissionValueResponse>

PaginatedFormSubmissionValueClient

Inherited Members

PaginatedResourceClient<FormSubmissionValue, FormSubmissionValueResource, FormSubmissionValueCollectionResponse, FormSubmissionValueResponse>.PerPage(int)

PaginatedResourceClient<FormSubmissionValue, FormSubmissionValueResource, FormSubmissionValueCollectionResponse, FormSubmissionValueResponse>.Offset(int)

PaginatedResourceClient<FormSubmissionValue, FormSubmissionValueResource, FormSubmissionValueCollectionResponse, FormSubmissionValueResponse>.Filter(string)

PaginatedResourceClient<FormSubmissionValue, FormSubmissionValueResource, FormSubmissionValueCollectionResponse, FormSubmissionValueResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<FormSubmissionValue, FormSubmissionValueResource, FormSubmissionValueCollectionResponse, FormSubmissionValueResponse>.PostAsync(FormSubmissionValue, CancellationToken)

PaginatedResourceClient<FormSubmissionValue, FormSubmissionValueResource, FormSubmissionValueCollectionResponse, FormSubmissionValueResponse>.PostAsync(JsonApiDocument<FormSubmissionValueResource>, CancellationToken)

ResourceClient<FormSubmissionValue>.AddQueryParameter(string, string)

ResourceClient<FormSubmissionValue>.ReplaceQueryParameter(string, string)

ResourceClient<FormSubmissionValue>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FormSubmissionValue>.Uri

ResourceClient<FormSubmissionValue>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedFormSubmissionValueClient(HttpClient, Uri)

Client for interacting with FormSubmissionValue collection resources.

public PaginatedFormSubmissionValueClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedFormSubmissionValueClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedFormSubmissionValueClient

The current PaginatedFormSubmissionValueClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedFormSubmissionValueClient ClearParameters()

Returns

PaginatedFormSubmissionValueClient

The current PaginatedFormSubmissionValueClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedFormSubmissionValueClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedFormSubmissionValueClient

The current PaginatedFormSubmissionValueClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of FormSubmissionValue resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormSubmissionValueCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedFormSubmissionValueClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedFormSubmissionValueClient

The current PaginatedFormSubmissionValueClient instance.

PerPage(int)

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

public PaginatedFormSubmissionValueClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedFormSubmissionValueClient

The current PaginatedFormSubmissionValueClient instance.

WithId(string)

Creates a new instance of a FormSubmissionValue client for a specific resource ID.

public FormSubmissionValueClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

FormSubmissionValueClient

A new instance of the resource client for the specified resource ID.