Class PaginatedWorkflowAssigneeWorkflowSummaryClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with WorkflowAssigneeWorkflowSummary collection resources.

public class PaginatedWorkflowAssigneeWorkflowSummaryClient : PaginatedResourceClient<WorkflowAssigneeWorkflowSummary, WorkflowAssigneeWorkflowSummaryResource, WorkflowAssigneeWorkflowSummaryCollectionResponse, WorkflowAssigneeWorkflowSummaryResponse>

Inheritance

object

ResourceClient<WorkflowAssigneeWorkflowSummary>

PaginatedResourceClient<WorkflowAssigneeWorkflowSummary, WorkflowAssigneeWorkflowSummaryResource, WorkflowAssigneeWorkflowSummaryCollectionResponse, WorkflowAssigneeWorkflowSummaryResponse>

PaginatedWorkflowAssigneeWorkflowSummaryClient

Inherited Members

PaginatedResourceClient<WorkflowAssigneeWorkflowSummary, WorkflowAssigneeWorkflowSummaryResource, WorkflowAssigneeWorkflowSummaryCollectionResponse, WorkflowAssigneeWorkflowSummaryResponse>.PerPage(int)

PaginatedResourceClient<WorkflowAssigneeWorkflowSummary, WorkflowAssigneeWorkflowSummaryResource, WorkflowAssigneeWorkflowSummaryCollectionResponse, WorkflowAssigneeWorkflowSummaryResponse>.Offset(int)

PaginatedResourceClient<WorkflowAssigneeWorkflowSummary, WorkflowAssigneeWorkflowSummaryResource, WorkflowAssigneeWorkflowSummaryCollectionResponse, WorkflowAssigneeWorkflowSummaryResponse>.Filter(string)

PaginatedResourceClient<WorkflowAssigneeWorkflowSummary, WorkflowAssigneeWorkflowSummaryResource, WorkflowAssigneeWorkflowSummaryCollectionResponse, WorkflowAssigneeWorkflowSummaryResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<WorkflowAssigneeWorkflowSummary, WorkflowAssigneeWorkflowSummaryResource, WorkflowAssigneeWorkflowSummaryCollectionResponse, WorkflowAssigneeWorkflowSummaryResponse>.PostAsync(WorkflowAssigneeWorkflowSummary, CancellationToken)

PaginatedResourceClient<WorkflowAssigneeWorkflowSummary, WorkflowAssigneeWorkflowSummaryResource, WorkflowAssigneeWorkflowSummaryCollectionResponse, WorkflowAssigneeWorkflowSummaryResponse>.PostAsync(JsonApiDocument<WorkflowAssigneeWorkflowSummaryResource>, CancellationToken)

ResourceClient<WorkflowAssigneeWorkflowSummary>.AddQueryParameter(string, string)

ResourceClient<WorkflowAssigneeWorkflowSummary>.ReplaceQueryParameter(string, string)

ResourceClient<WorkflowAssigneeWorkflowSummary>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<WorkflowAssigneeWorkflowSummary>.Uri

ResourceClient<WorkflowAssigneeWorkflowSummary>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedWorkflowAssigneeWorkflowSummaryClient(HttpClient, Uri)

Client for interacting with WorkflowAssigneeWorkflowSummary collection resources.

public PaginatedWorkflowAssigneeWorkflowSummaryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedWorkflowAssigneeWorkflowSummaryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedWorkflowAssigneeWorkflowSummaryClient

The current PaginatedWorkflowAssigneeWorkflowSummaryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedWorkflowAssigneeWorkflowSummaryClient ClearParameters()

Returns

PaginatedWorkflowAssigneeWorkflowSummaryClient

The current PaginatedWorkflowAssigneeWorkflowSummaryClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedWorkflowAssigneeWorkflowSummaryClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedWorkflowAssigneeWorkflowSummaryClient

The current PaginatedWorkflowAssigneeWorkflowSummaryClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of WorkflowAssigneeWorkflowSummary resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowAssigneeWorkflowSummaryCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedWorkflowAssigneeWorkflowSummaryClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedWorkflowAssigneeWorkflowSummaryClient

The current PaginatedWorkflowAssigneeWorkflowSummaryClient instance.

OrderByOverdueCount()

Sort response items by the OverdueCount attribute.

public WorkflowAssigneeWorkflowSummaryClient OrderByOverdueCount()

Returns

WorkflowAssigneeWorkflowSummaryClient

OrderByOverdueCountDescending()

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

public WorkflowAssigneeWorkflowSummaryClient OrderByOverdueCountDescending()

Returns

WorkflowAssigneeWorkflowSummaryClient

OrderByReadyCount()

Sort response items by the ReadyCount attribute.

public WorkflowAssigneeWorkflowSummaryClient OrderByReadyCount()

Returns

WorkflowAssigneeWorkflowSummaryClient

OrderByReadyCountDescending()

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

public WorkflowAssigneeWorkflowSummaryClient OrderByReadyCountDescending()

Returns

WorkflowAssigneeWorkflowSummaryClient

OrderBySnoozedCount()

Sort response items by the SnoozedCount attribute.

public WorkflowAssigneeWorkflowSummaryClient OrderBySnoozedCount()

Returns

WorkflowAssigneeWorkflowSummaryClient

OrderBySnoozedCountDescending()

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

public WorkflowAssigneeWorkflowSummaryClient OrderBySnoozedCountDescending()

Returns

WorkflowAssigneeWorkflowSummaryClient

OrderByWorkflowName()

Sort response items by the WorkflowName attribute.

public WorkflowAssigneeWorkflowSummaryClient OrderByWorkflowName()

Returns

WorkflowAssigneeWorkflowSummaryClient

OrderByWorkflowNameDescending()

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

public WorkflowAssigneeWorkflowSummaryClient OrderByWorkflowNameDescending()

Returns

WorkflowAssigneeWorkflowSummaryClient

PerPage(int)

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

public PaginatedWorkflowAssigneeWorkflowSummaryClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedWorkflowAssigneeWorkflowSummaryClient

The current PaginatedWorkflowAssigneeWorkflowSummaryClient instance.

WithId(string)

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

public WorkflowAssigneeWorkflowSummaryClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

WorkflowAssigneeWorkflowSummaryClient

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