Class PaginatedWorkflowStepClient

Namespace

Crews.PlanningCenter.Api.People.V2020_04_06

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with WorkflowStep collection resources.

public class PaginatedWorkflowStepClient : PaginatedResourceClient<WorkflowStep, WorkflowStepResource, WorkflowStepCollectionResponse, WorkflowStepResponse>

Inheritance

object

ResourceClient<WorkflowStep>

PaginatedResourceClient<WorkflowStep, WorkflowStepResource, WorkflowStepCollectionResponse, WorkflowStepResponse>

PaginatedWorkflowStepClient

Inherited Members

PaginatedResourceClient<WorkflowStep, WorkflowStepResource, WorkflowStepCollectionResponse, WorkflowStepResponse>.PerPage(int)

PaginatedResourceClient<WorkflowStep, WorkflowStepResource, WorkflowStepCollectionResponse, WorkflowStepResponse>.Offset(int)

PaginatedResourceClient<WorkflowStep, WorkflowStepResource, WorkflowStepCollectionResponse, WorkflowStepResponse>.Filter(string)

PaginatedResourceClient<WorkflowStep, WorkflowStepResource, WorkflowStepCollectionResponse, WorkflowStepResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<WorkflowStep, WorkflowStepResource, WorkflowStepCollectionResponse, WorkflowStepResponse>.PostAsync(WorkflowStep, CancellationToken)

PaginatedResourceClient<WorkflowStep, WorkflowStepResource, WorkflowStepCollectionResponse, WorkflowStepResponse>.PostAsync(JsonApiDocument<WorkflowStepResource>, CancellationToken)

ResourceClient<WorkflowStep>.AddQueryParameter(string, string)

ResourceClient<WorkflowStep>.ReplaceQueryParameter(string, string)

ResourceClient<WorkflowStep>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<WorkflowStep>.Uri

ResourceClient<WorkflowStep>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedWorkflowStepClient(HttpClient, Uri)

Client for interacting with WorkflowStep collection resources.

public PaginatedWorkflowStepClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedWorkflowStepClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedWorkflowStepClient

The current PaginatedWorkflowStepClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedWorkflowStepClient ClearParameters()

Returns

PaginatedWorkflowStepClient

The current PaginatedWorkflowStepClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedWorkflowStepClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedWorkflowStepClient

The current PaginatedWorkflowStepClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of WorkflowStep resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowStepCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeDefaultAssignee()

Include related DefaultAssignee resources in the response.

public WorkflowStepClient IncludeDefaultAssignee()

Returns

WorkflowStepClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedWorkflowStepClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedWorkflowStepClient

The current PaginatedWorkflowStepClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public WorkflowStepClient OrderByCreatedAt()

Returns

WorkflowStepClient

OrderByCreatedAtDescending()

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

public WorkflowStepClient OrderByCreatedAtDescending()

Returns

WorkflowStepClient

OrderByName()

Sort response items by the Name attribute.

public WorkflowStepClient OrderByName()

Returns

WorkflowStepClient

OrderByNameDescending()

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

public WorkflowStepClient OrderByNameDescending()

Returns

WorkflowStepClient

OrderBySequence()

Sort response items by the Sequence attribute.

public WorkflowStepClient OrderBySequence()

Returns

WorkflowStepClient

OrderBySequenceDescending()

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

public WorkflowStepClient OrderBySequenceDescending()

Returns

WorkflowStepClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public WorkflowStepClient OrderByUpdatedAt()

Returns

WorkflowStepClient

OrderByUpdatedAtDescending()

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

public WorkflowStepClient OrderByUpdatedAtDescending()

Returns

WorkflowStepClient

PerPage(int)

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

public PaginatedWorkflowStepClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedWorkflowStepClient

The current PaginatedWorkflowStepClient instance.

PostAsync(WorkflowStep, CancellationToken)

Creates a new WorkflowStep resource asynchronously.

public Task<WorkflowStepResponse> PostAsync(WorkflowStep resource, CancellationToken cancellationToken = default)

Parameters

resource WorkflowStep

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowStepResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<WorkflowStepResource>, CancellationToken)

Creates a new WorkflowStep resource asynchronously.

public Task<WorkflowStepResponse> PostAsync(JsonApiDocument<WorkflowStepResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<WorkflowStepResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowStepResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public WorkflowStepClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

WorkflowStepClient

WhereName(string)

Query response items by the Name attribute.

public WorkflowStepClient WhereName(string value)

Parameters

value string

Returns

WorkflowStepClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public WorkflowStepClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

WorkflowStepClient

WithId(string)

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

public WorkflowStepClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

WorkflowStepClient

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