Class PaginatedWorkflowCategoryClient

Namespace

Crews.PlanningCenter.Api.People.V2025_07_02

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with WorkflowCategory collection resources.

public class PaginatedWorkflowCategoryClient : PaginatedResourceClient<WorkflowCategory, WorkflowCategoryResource, WorkflowCategoryCollectionResponse, WorkflowCategoryResponse>

Inheritance

object

ResourceClient<WorkflowCategory>

PaginatedResourceClient<WorkflowCategory, WorkflowCategoryResource, WorkflowCategoryCollectionResponse, WorkflowCategoryResponse>

PaginatedWorkflowCategoryClient

Inherited Members

PaginatedResourceClient<WorkflowCategory, WorkflowCategoryResource, WorkflowCategoryCollectionResponse, WorkflowCategoryResponse>.PerPage(int)

PaginatedResourceClient<WorkflowCategory, WorkflowCategoryResource, WorkflowCategoryCollectionResponse, WorkflowCategoryResponse>.Offset(int)

PaginatedResourceClient<WorkflowCategory, WorkflowCategoryResource, WorkflowCategoryCollectionResponse, WorkflowCategoryResponse>.Filter(string)

PaginatedResourceClient<WorkflowCategory, WorkflowCategoryResource, WorkflowCategoryCollectionResponse, WorkflowCategoryResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<WorkflowCategory, WorkflowCategoryResource, WorkflowCategoryCollectionResponse, WorkflowCategoryResponse>.PostAsync(WorkflowCategory, CancellationToken)

PaginatedResourceClient<WorkflowCategory, WorkflowCategoryResource, WorkflowCategoryCollectionResponse, WorkflowCategoryResponse>.PostAsync(JsonApiDocument<WorkflowCategoryResource>, CancellationToken)

ResourceClient<WorkflowCategory>.AddQueryParameter(string, string)

ResourceClient<WorkflowCategory>.ReplaceQueryParameter(string, string)

ResourceClient<WorkflowCategory>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<WorkflowCategory>.Uri

ResourceClient<WorkflowCategory>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedWorkflowCategoryClient(HttpClient, Uri)

Client for interacting with WorkflowCategory collection resources.

public PaginatedWorkflowCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedWorkflowCategoryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedWorkflowCategoryClient

The current PaginatedWorkflowCategoryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedWorkflowCategoryClient ClearParameters()

Returns

PaginatedWorkflowCategoryClient

The current PaginatedWorkflowCategoryClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedWorkflowCategoryClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedWorkflowCategoryClient

The current PaginatedWorkflowCategoryClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of WorkflowCategory resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCategoryCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedWorkflowCategoryClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedWorkflowCategoryClient

The current PaginatedWorkflowCategoryClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public WorkflowCategoryClient OrderByCreatedAt()

Returns

WorkflowCategoryClient

OrderByCreatedAtDescending()

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

public WorkflowCategoryClient OrderByCreatedAtDescending()

Returns

WorkflowCategoryClient

OrderByName()

Sort response items by the Name attribute.

public WorkflowCategoryClient OrderByName()

Returns

WorkflowCategoryClient

OrderByNameDescending()

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

public WorkflowCategoryClient OrderByNameDescending()

Returns

WorkflowCategoryClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public WorkflowCategoryClient OrderByUpdatedAt()

Returns

WorkflowCategoryClient

OrderByUpdatedAtDescending()

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

public WorkflowCategoryClient OrderByUpdatedAtDescending()

Returns

WorkflowCategoryClient

PerPage(int)

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

public PaginatedWorkflowCategoryClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedWorkflowCategoryClient

The current PaginatedWorkflowCategoryClient instance.

PostAsync(WorkflowCategory, CancellationToken)

Creates a new WorkflowCategory resource asynchronously.

public Task<WorkflowCategoryResponse> PostAsync(WorkflowCategory resource, CancellationToken cancellationToken = default)

Parameters

resource WorkflowCategory

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<WorkflowCategoryResource>, CancellationToken)

Creates a new WorkflowCategory resource asynchronously.

public Task<WorkflowCategoryResponse> PostAsync(JsonApiDocument<WorkflowCategoryResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<WorkflowCategoryResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public WorkflowCategoryClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

WorkflowCategoryClient

WhereName(string)

Query response items by the Name attribute.

public WorkflowCategoryClient WhereName(string value)

Parameters

value string

Returns

WorkflowCategoryClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public WorkflowCategoryClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

WorkflowCategoryClient

WithId(string)

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

public WorkflowCategoryClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

WorkflowCategoryClient

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