Class PaginatedWorkflowCardActivityClient

Namespace

Crews.PlanningCenter.Api.People.V2020_07_22

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with WorkflowCardActivity collection resources.

public class PaginatedWorkflowCardActivityClient : PaginatedResourceClient<WorkflowCardActivity, WorkflowCardActivityResource, WorkflowCardActivityCollectionResponse, WorkflowCardActivityResponse>

Inheritance

object

ResourceClient<WorkflowCardActivity>

PaginatedResourceClient<WorkflowCardActivity, WorkflowCardActivityResource, WorkflowCardActivityCollectionResponse, WorkflowCardActivityResponse>

PaginatedWorkflowCardActivityClient

Inherited Members

PaginatedResourceClient<WorkflowCardActivity, WorkflowCardActivityResource, WorkflowCardActivityCollectionResponse, WorkflowCardActivityResponse>.PerPage(int)

PaginatedResourceClient<WorkflowCardActivity, WorkflowCardActivityResource, WorkflowCardActivityCollectionResponse, WorkflowCardActivityResponse>.Offset(int)

PaginatedResourceClient<WorkflowCardActivity, WorkflowCardActivityResource, WorkflowCardActivityCollectionResponse, WorkflowCardActivityResponse>.Filter(string)

PaginatedResourceClient<WorkflowCardActivity, WorkflowCardActivityResource, WorkflowCardActivityCollectionResponse, WorkflowCardActivityResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<WorkflowCardActivity, WorkflowCardActivityResource, WorkflowCardActivityCollectionResponse, WorkflowCardActivityResponse>.PostAsync(WorkflowCardActivity, CancellationToken)

PaginatedResourceClient<WorkflowCardActivity, WorkflowCardActivityResource, WorkflowCardActivityCollectionResponse, WorkflowCardActivityResponse>.PostAsync(JsonApiDocument<WorkflowCardActivityResource>, CancellationToken)

ResourceClient<WorkflowCardActivity>.AddQueryParameter(string, string)

ResourceClient<WorkflowCardActivity>.ReplaceQueryParameter(string, string)

ResourceClient<WorkflowCardActivity>.AddCustomParameter(string, string)

ResourceClient<WorkflowCardActivity>.ClearParameters()

ResourceClient<WorkflowCardActivity>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<WorkflowCardActivity>.Uri

ResourceClient<WorkflowCardActivity>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedWorkflowCardActivityClient(HttpClient, Uri)

Client for interacting with WorkflowCardActivity collection resources.

public PaginatedWorkflowCardActivityClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of WorkflowCardActivity resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCardActivityCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderById()

Sort response items by the Id attribute.

public WorkflowCardActivityClient OrderById()

Returns

WorkflowCardActivityClient

OrderByIdDescending()

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

public WorkflowCardActivityClient OrderByIdDescending()

Returns

WorkflowCardActivityClient

WithId(string)

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

public WorkflowCardActivityClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

WorkflowCardActivityClient

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