Class PaginatedFormCategoryClient

Namespace

Crews.PlanningCenter.Api.People.V2019_01_14

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with FormCategory collection resources.

public class PaginatedFormCategoryClient : PaginatedResourceClient<FormCategory, FormCategoryResource, FormCategoryCollectionResponse, FormCategoryResponse>

Inheritance

object

ResourceClient<FormCategory>

PaginatedResourceClient<FormCategory, FormCategoryResource, FormCategoryCollectionResponse, FormCategoryResponse>

PaginatedFormCategoryClient

Inherited Members

PaginatedResourceClient<FormCategory, FormCategoryResource, FormCategoryCollectionResponse, FormCategoryResponse>.PerPage(int)

PaginatedResourceClient<FormCategory, FormCategoryResource, FormCategoryCollectionResponse, FormCategoryResponse>.Offset(int)

PaginatedResourceClient<FormCategory, FormCategoryResource, FormCategoryCollectionResponse, FormCategoryResponse>.Filter(string)

PaginatedResourceClient<FormCategory, FormCategoryResource, FormCategoryCollectionResponse, FormCategoryResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<FormCategory, FormCategoryResource, FormCategoryCollectionResponse, FormCategoryResponse>.PostAsync(FormCategory, CancellationToken)

PaginatedResourceClient<FormCategory, FormCategoryResource, FormCategoryCollectionResponse, FormCategoryResponse>.PostAsync(JsonApiDocument<FormCategoryResource>, CancellationToken)

ResourceClient<FormCategory>.AddQueryParameter(string, string)

ResourceClient<FormCategory>.ReplaceQueryParameter(string, string)

ResourceClient<FormCategory>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FormCategory>.Uri

ResourceClient<FormCategory>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedFormCategoryClient(HttpClient, Uri)

Client for interacting with FormCategory collection resources.

public PaginatedFormCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedFormCategoryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedFormCategoryClient

The current PaginatedFormCategoryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedFormCategoryClient ClearParameters()

Returns

PaginatedFormCategoryClient

The current PaginatedFormCategoryClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedFormCategoryClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedFormCategoryClient

The current PaginatedFormCategoryClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of FormCategory resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormCategoryCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedFormCategoryClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedFormCategoryClient

The current PaginatedFormCategoryClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public FormCategoryClient OrderByCreatedAt()

Returns

FormCategoryClient

OrderByCreatedAtDescending()

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

public FormCategoryClient OrderByCreatedAtDescending()

Returns

FormCategoryClient

OrderByName()

Sort response items by the Name attribute.

public FormCategoryClient OrderByName()

Returns

FormCategoryClient

OrderByNameDescending()

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

public FormCategoryClient OrderByNameDescending()

Returns

FormCategoryClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public FormCategoryClient OrderByUpdatedAt()

Returns

FormCategoryClient

OrderByUpdatedAtDescending()

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

public FormCategoryClient OrderByUpdatedAtDescending()

Returns

FormCategoryClient

PerPage(int)

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

public PaginatedFormCategoryClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedFormCategoryClient

The current PaginatedFormCategoryClient instance.

PostAsync(FormCategory, CancellationToken)

Creates a new FormCategory resource asynchronously.

public Task<FormCategoryResponse> PostAsync(FormCategory resource, CancellationToken cancellationToken = default)

Parameters

resource FormCategory

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormCategoryResponse>

A task representing the asynchronous operation, containing the created FormCategory resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<FormCategoryResource>, CancellationToken)

Creates a new FormCategory resource asynchronously.

public Task<FormCategoryResponse> PostAsync(JsonApiDocument<FormCategoryResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<FormCategoryResource>

The JSON:API document to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormCategoryResponse>

A task representing the asynchronous operation, containing the created FormCategory resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public FormCategoryClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

FormCategoryClient

WhereName(string)

Query response items by the Name attribute.

public FormCategoryClient WhereName(string value)

Parameters

value string

Returns

FormCategoryClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public FormCategoryClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

FormCategoryClient

WithId(string)

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

public FormCategoryClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

FormCategoryClient

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