Class PaginatedWorkflowCardClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with WorkflowCard collection resources.

public class PaginatedWorkflowCardClient : PaginatedResourceClient<WorkflowCard, WorkflowCardResource, WorkflowCardCollectionResponse, WorkflowCardResponse>

Inheritance

object

ResourceClient<WorkflowCard>

PaginatedResourceClient<WorkflowCard, WorkflowCardResource, WorkflowCardCollectionResponse, WorkflowCardResponse>

PaginatedWorkflowCardClient

Inherited Members

PaginatedResourceClient<WorkflowCard, WorkflowCardResource, WorkflowCardCollectionResponse, WorkflowCardResponse>.PerPage(int)

PaginatedResourceClient<WorkflowCard, WorkflowCardResource, WorkflowCardCollectionResponse, WorkflowCardResponse>.Offset(int)

PaginatedResourceClient<WorkflowCard, WorkflowCardResource, WorkflowCardCollectionResponse, WorkflowCardResponse>.Filter(string)

PaginatedResourceClient<WorkflowCard, WorkflowCardResource, WorkflowCardCollectionResponse, WorkflowCardResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<WorkflowCard, WorkflowCardResource, WorkflowCardCollectionResponse, WorkflowCardResponse>.PostAsync(WorkflowCard, CancellationToken)

PaginatedResourceClient<WorkflowCard, WorkflowCardResource, WorkflowCardCollectionResponse, WorkflowCardResponse>.PostAsync(JsonApiDocument<WorkflowCardResource>, CancellationToken)

ResourceClient<WorkflowCard>.AddQueryParameter(string, string)

ResourceClient<WorkflowCard>.ReplaceQueryParameter(string, string)

ResourceClient<WorkflowCard>.AddCustomParameter(string, string)

ResourceClient<WorkflowCard>.ClearParameters()

ResourceClient<WorkflowCard>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<WorkflowCard>.Uri

ResourceClient<WorkflowCard>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedWorkflowCardClient(HttpClient, Uri)

Client for interacting with WorkflowCard collection resources.

public PaginatedWorkflowCardClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of WorkflowCard resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCardCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeAssignee()

Include related Assignee resources in the response.

public WorkflowCardClient IncludeAssignee()

Returns

WorkflowCardClient

IncludeCurrentStep()

Include related CurrentStep resources in the response.

public WorkflowCardClient IncludeCurrentStep()

Returns

WorkflowCardClient

IncludePerson()

Include related Person resources in the response.

public WorkflowCardClient IncludePerson()

Returns

WorkflowCardClient

IncludeWorkflow()

Include related Workflow resources in the response.

public WorkflowCardClient IncludeWorkflow()

Returns

WorkflowCardClient

OrderByCompletedAt()

Sort response items by the CompletedAt attribute.

public WorkflowCardClient OrderByCompletedAt()

Returns

WorkflowCardClient

OrderByCompletedAtDescending()

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

public WorkflowCardClient OrderByCompletedAtDescending()

Returns

WorkflowCardClient

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public WorkflowCardClient OrderByCreatedAt()

Returns

WorkflowCardClient

OrderByCreatedAtDescending()

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

public WorkflowCardClient OrderByCreatedAtDescending()

Returns

WorkflowCardClient

OrderByFirstName()

Sort response items by the FirstName attribute.

public WorkflowCardClient OrderByFirstName()

Returns

WorkflowCardClient

OrderByFirstNameDescending()

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

public WorkflowCardClient OrderByFirstNameDescending()

Returns

WorkflowCardClient

OrderByFlaggedForNotificationAt()

Sort response items by the FlaggedForNotificationAt attribute.

public WorkflowCardClient OrderByFlaggedForNotificationAt()

Returns

WorkflowCardClient

OrderByFlaggedForNotificationAtDescending()

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

public WorkflowCardClient OrderByFlaggedForNotificationAtDescending()

Returns

WorkflowCardClient

OrderByLastName()

Sort response items by the LastName attribute.

public WorkflowCardClient OrderByLastName()

Returns

WorkflowCardClient

OrderByLastNameDescending()

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

public WorkflowCardClient OrderByLastNameDescending()

Returns

WorkflowCardClient

OrderByMovedToStepAt()

Sort response items by the MovedToStepAt attribute.

public WorkflowCardClient OrderByMovedToStepAt()

Returns

WorkflowCardClient

OrderByMovedToStepAtDescending()

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

public WorkflowCardClient OrderByMovedToStepAtDescending()

Returns

WorkflowCardClient

OrderByRemovedAt()

Sort response items by the RemovedAt attribute.

public WorkflowCardClient OrderByRemovedAt()

Returns

WorkflowCardClient

OrderByRemovedAtDescending()

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

public WorkflowCardClient OrderByRemovedAtDescending()

Returns

WorkflowCardClient

OrderByStage()

Sort response items by the Stage attribute.

public WorkflowCardClient OrderByStage()

Returns

WorkflowCardClient

OrderByStageDescending()

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

public WorkflowCardClient OrderByStageDescending()

Returns

WorkflowCardClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public WorkflowCardClient OrderByUpdatedAt()

Returns

WorkflowCardClient

OrderByUpdatedAtDescending()

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

public WorkflowCardClient OrderByUpdatedAtDescending()

Returns

WorkflowCardClient

PostAsync(WorkflowCard, CancellationToken)

Creates a new WorkflowCard resource asynchronously.

public Task<WorkflowCardResponse> PostAsync(WorkflowCard resource, CancellationToken cancellationToken = default)

Parameters

resource WorkflowCard

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCardResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<WorkflowCardResource>, CancellationToken)

Creates a new WorkflowCard resource asynchronously.

public Task<WorkflowCardResponse> PostAsync(JsonApiDocument<WorkflowCardResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<WorkflowCardResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCardResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereAssigneeId(int)

Query response items by the AssigneeId attribute.

public WorkflowCardClient WhereAssigneeId(int value)

Parameters

value int

Returns

WorkflowCardClient

WhereOverdue(bool)

Query response items by the Overdue attribute.

public WorkflowCardClient WhereOverdue(bool value)

Parameters

value bool

Returns

WorkflowCardClient

WhereStage(string)

Query response items by the Stage attribute.

public WorkflowCardClient WhereStage(string value)

Parameters

value string

Returns

WorkflowCardClient

WithId(string)

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

public WorkflowCardClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

WorkflowCardClient

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