Class PaginatedFormClient

Namespace

Crews.PlanningCenter.Api.People.V2020_04_06

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Form collection resources.

public class PaginatedFormClient : PaginatedResourceClient<Form, FormResource, FormCollectionResponse, FormResponse>

Inheritance

object

ResourceClient<Form>

PaginatedResourceClient<Form, FormResource, FormCollectionResponse, FormResponse>

PaginatedFormClient

Inherited Members

PaginatedResourceClient<Form, FormResource, FormCollectionResponse, FormResponse>.PerPage(int)

PaginatedResourceClient<Form, FormResource, FormCollectionResponse, FormResponse>.Offset(int)

PaginatedResourceClient<Form, FormResource, FormCollectionResponse, FormResponse>.Filter(string)

PaginatedResourceClient<Form, FormResource, FormCollectionResponse, FormResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Form, FormResource, FormCollectionResponse, FormResponse>.PostAsync(Form, CancellationToken)

PaginatedResourceClient<Form, FormResource, FormCollectionResponse, FormResponse>.PostAsync(JsonApiDocument<FormResource>, CancellationToken)

ResourceClient<Form>.AddQueryParameter(string, string)

ResourceClient<Form>.ReplaceQueryParameter(string, string)

ResourceClient<Form>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Form>.Uri

ResourceClient<Form>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedFormClient(HttpClient, Uri)

Client for interacting with Form collection resources.

public PaginatedFormClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedFormClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedFormClient

The current PaginatedFormClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedFormClient ClearParameters()

Returns

PaginatedFormClient

The current PaginatedFormClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedFormClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedFormClient

The current PaginatedFormClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Form resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCampus()

Include related Campus resources in the response.

public FormClient IncludeCampus()

Returns

FormClient

IncludeCategory()

Include related Category resources in the response.

public FormClient IncludeCategory()

Returns

FormClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedFormClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedFormClient

The current PaginatedFormClient instance.

OrderByActive()

Sort response items by the Active attribute.

public FormClient OrderByActive()

Returns

FormClient

OrderByActiveDescending()

Sort response items by the Active attribute. Use reverse order.

public FormClient OrderByActiveDescending()

Returns

FormClient

OrderByArchivedAt()

Sort response items by the ArchivedAt attribute.

public FormClient OrderByArchivedAt()

Returns

FormClient

OrderByArchivedAtDescending()

Sort response items by the ArchivedAt attribute. Use reverse order.

public FormClient OrderByArchivedAtDescending()

Returns

FormClient

OrderByCampus()

Sort response items by the Campus attribute.

public FormClient OrderByCampus()

Returns

FormClient

OrderByCampusDescending()

Sort response items by the Campus attribute. Use reverse order.

public FormClient OrderByCampusDescending()

Returns

FormClient

OrderByCategory()

Sort response items by the Category attribute.

public FormClient OrderByCategory()

Returns

FormClient

OrderByCategoryDescending()

Sort response items by the Category attribute. Use reverse order.

public FormClient OrderByCategoryDescending()

Returns

FormClient

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public FormClient OrderByCreatedAt()

Returns

FormClient

OrderByCreatedAtDescending()

Sort response items by the CreatedAt attribute. Use reverse order.

public FormClient OrderByCreatedAtDescending()

Returns

FormClient

OrderByDeletedAt()

Sort response items by the DeletedAt attribute.

public FormClient OrderByDeletedAt()

Returns

FormClient

OrderByDeletedAtDescending()

Sort response items by the DeletedAt attribute. Use reverse order.

public FormClient OrderByDeletedAtDescending()

Returns

FormClient

OrderByDescription()

Sort response items by the Description attribute.

public FormClient OrderByDescription()

Returns

FormClient

OrderByDescriptionDescending()

Sort response items by the Description attribute. Use reverse order.

public FormClient OrderByDescriptionDescending()

Returns

FormClient

OrderByName()

Sort response items by the Name attribute.

public FormClient OrderByName()

Returns

FormClient

OrderByNameDescending()

Sort response items by the Name attribute. Use reverse order.

public FormClient OrderByNameDescending()

Returns

FormClient

OrderBySubmissionCount()

Sort response items by the SubmissionCount attribute.

public FormClient OrderBySubmissionCount()

Returns

FormClient

OrderBySubmissionCountDescending()

Sort response items by the SubmissionCount attribute. Use reverse order.

public FormClient OrderBySubmissionCountDescending()

Returns

FormClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public FormClient OrderByUpdatedAt()

Returns

FormClient

OrderByUpdatedAtDescending()

Sort response items by the UpdatedAt attribute. Use reverse order.

public FormClient OrderByUpdatedAtDescending()

Returns

FormClient

PerPage(int)

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

public PaginatedFormClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedFormClient

The current PaginatedFormClient instance.

WhereActive(bool)

Query response items by the Active attribute.

public FormClient WhereActive(bool value)

Parameters

value bool

Returns

FormClient

WhereId(string)

Query response items by the Id attribute.

public FormClient WhereId(string value)

Parameters

value string

Returns

FormClient

WithId(string)

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

public FormClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

FormClient

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