Class PaginatedWorkflowClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Workflow collection resources.

public class PaginatedWorkflowClient : PaginatedResourceClient<Workflow, WorkflowResource, WorkflowCollectionResponse, WorkflowResponse>

Inheritance

object

ResourceClient<Workflow>

PaginatedResourceClient<Workflow, WorkflowResource, WorkflowCollectionResponse, WorkflowResponse>

PaginatedWorkflowClient

Inherited Members

PaginatedResourceClient<Workflow, WorkflowResource, WorkflowCollectionResponse, WorkflowResponse>.PerPage(int)

PaginatedResourceClient<Workflow, WorkflowResource, WorkflowCollectionResponse, WorkflowResponse>.Offset(int)

PaginatedResourceClient<Workflow, WorkflowResource, WorkflowCollectionResponse, WorkflowResponse>.Filter(string)

PaginatedResourceClient<Workflow, WorkflowResource, WorkflowCollectionResponse, WorkflowResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Workflow, WorkflowResource, WorkflowCollectionResponse, WorkflowResponse>.PostAsync(Workflow, CancellationToken)

PaginatedResourceClient<Workflow, WorkflowResource, WorkflowCollectionResponse, WorkflowResponse>.PostAsync(JsonApiDocument<WorkflowResource>, CancellationToken)

ResourceClient<Workflow>.AddQueryParameter(string, string)

ResourceClient<Workflow>.ReplaceQueryParameter(string, string)

ResourceClient<Workflow>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Workflow>.Uri

ResourceClient<Workflow>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedWorkflowClient(HttpClient, Uri)

Client for interacting with Workflow collection resources.

public PaginatedWorkflowClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedWorkflowClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedWorkflowClient

The current PaginatedWorkflowClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedWorkflowClient ClearParameters()

Returns

PaginatedWorkflowClient

The current PaginatedWorkflowClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedWorkflowClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedWorkflowClient

The current PaginatedWorkflowClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Workflow resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCategory()

Include related Category resources in the response.

public WorkflowClient IncludeCategory()

Returns

WorkflowClient

IncludeShares()

Include related Shares resources in the response.

public WorkflowClient IncludeShares()

Returns

WorkflowClient

IncludeSteps()

Include related Steps resources in the response.

public WorkflowClient IncludeSteps()

Returns

WorkflowClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedWorkflowClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedWorkflowClient

The current PaginatedWorkflowClient instance.

OrderByArchivedAt()

Sort response items by the ArchivedAt attribute.

public WorkflowClient OrderByArchivedAt()

Returns

WorkflowClient

OrderByArchivedAtDescending()

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

public WorkflowClient OrderByArchivedAtDescending()

Returns

WorkflowClient

OrderByCampusId()

Sort response items by the CampusId attribute.

public WorkflowClient OrderByCampusId()

Returns

WorkflowClient

OrderByCampusIdDescending()

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

public WorkflowClient OrderByCampusIdDescending()

Returns

WorkflowClient

OrderByCampusName()

Sort response items by the CampusName attribute.

public WorkflowClient OrderByCampusName()

Returns

WorkflowClient

OrderByCampusNameDescending()

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

public WorkflowClient OrderByCampusNameDescending()

Returns

WorkflowClient

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public WorkflowClient OrderByCreatedAt()

Returns

WorkflowClient

OrderByCreatedAtDescending()

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

public WorkflowClient OrderByCreatedAtDescending()

Returns

WorkflowClient

OrderByDeletedAt()

Sort response items by the DeletedAt attribute.

public WorkflowClient OrderByDeletedAt()

Returns

WorkflowClient

OrderByDeletedAtDescending()

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

public WorkflowClient OrderByDeletedAtDescending()

Returns

WorkflowClient

OrderByMyReadyCardCount()

Sort response items by the MyReadyCardCount attribute.

public WorkflowClient OrderByMyReadyCardCount()

Returns

WorkflowClient

OrderByMyReadyCardCountDescending()

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

public WorkflowClient OrderByMyReadyCardCountDescending()

Returns

WorkflowClient

OrderByName()

Sort response items by the Name attribute.

public WorkflowClient OrderByName()

Returns

WorkflowClient

OrderByNameDescending()

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

public WorkflowClient OrderByNameDescending()

Returns

WorkflowClient

OrderByTotalOverdueCardCount()

Sort response items by the TotalOverdueCardCount attribute.

public WorkflowClient OrderByTotalOverdueCardCount()

Returns

WorkflowClient

OrderByTotalOverdueCardCountDescending()

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

public WorkflowClient OrderByTotalOverdueCardCountDescending()

Returns

WorkflowClient

OrderByTotalReadyCardCount()

Sort response items by the TotalReadyCardCount attribute.

public WorkflowClient OrderByTotalReadyCardCount()

Returns

WorkflowClient

OrderByTotalReadyCardCountDescending()

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

public WorkflowClient OrderByTotalReadyCardCountDescending()

Returns

WorkflowClient

OrderByTotalUnassignedCardCount()

Sort response items by the TotalUnassignedCardCount attribute.

public WorkflowClient OrderByTotalUnassignedCardCount()

Returns

WorkflowClient

OrderByTotalUnassignedCardCountDescending()

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

public WorkflowClient OrderByTotalUnassignedCardCountDescending()

Returns

WorkflowClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public WorkflowClient OrderByUpdatedAt()

Returns

WorkflowClient

OrderByUpdatedAtDescending()

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

public WorkflowClient OrderByUpdatedAtDescending()

Returns

WorkflowClient

OrderByWorkflowCategoryId()

Sort response items by the WorkflowCategoryId attribute.

public WorkflowClient OrderByWorkflowCategoryId()

Returns

WorkflowClient

OrderByWorkflowCategoryIdDescending()

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

public WorkflowClient OrderByWorkflowCategoryIdDescending()

Returns

WorkflowClient

OrderByWorkflowCategoryName()

Sort response items by the WorkflowCategoryName attribute.

public WorkflowClient OrderByWorkflowCategoryName()

Returns

WorkflowClient

OrderByWorkflowCategoryNameDescending()

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

public WorkflowClient OrderByWorkflowCategoryNameDescending()

Returns

WorkflowClient

PerPage(int)

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

public PaginatedWorkflowClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedWorkflowClient

The current PaginatedWorkflowClient instance.

PostAsync(Workflow, CancellationToken)

Creates a new Workflow resource asynchronously.

public Task<WorkflowResponse> PostAsync(Workflow resource, CancellationToken cancellationToken = default)

Parameters

resource Workflow

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<WorkflowResource>, CancellationToken)

Creates a new Workflow resource asynchronously.

public Task<WorkflowResponse> PostAsync(JsonApiDocument<WorkflowResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<WorkflowResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereArchivedAt(DateTime)

Query response items by the ArchivedAt attribute.

public WorkflowClient WhereArchivedAt(DateTime value)

Parameters

value DateTime

Returns

WorkflowClient

WhereCampusId(string)

Query response items by the CampusId attribute.

public WorkflowClient WhereCampusId(string value)

Parameters

value string

Returns

WorkflowClient

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public WorkflowClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

WorkflowClient

WhereDeletedAt(DateTime)

Query response items by the DeletedAt attribute.

public WorkflowClient WhereDeletedAt(DateTime value)

Parameters

value DateTime

Returns

WorkflowClient

WhereId(string)

Query response items by the Id attribute.

public WorkflowClient WhereId(string value)

Parameters

value string

Returns

WorkflowClient

WhereName(string)

Query response items by the Name attribute.

public WorkflowClient WhereName(string value)

Parameters

value string

Returns

WorkflowClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public WorkflowClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

WorkflowClient

WhereWorkflowCategoryId(string)

Query response items by the WorkflowCategoryId attribute.

public WorkflowClient WhereWorkflowCategoryId(string value)

Parameters

value string

Returns

WorkflowClient

WithId(string)

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

public WorkflowClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

WorkflowClient

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