Class PaginatedWorkflowAssigneeSummaryClient

Namespace

Crews.PlanningCenter.Api.People.V2021_08_17

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with WorkflowAssigneeSummary collection resources.

public class PaginatedWorkflowAssigneeSummaryClient : PaginatedResourceClient<WorkflowAssigneeSummary, WorkflowAssigneeSummaryResource, WorkflowAssigneeSummaryCollectionResponse, WorkflowAssigneeSummaryResponse>

Inheritance

object

ResourceClient<WorkflowAssigneeSummary>

PaginatedResourceClient<WorkflowAssigneeSummary, WorkflowAssigneeSummaryResource, WorkflowAssigneeSummaryCollectionResponse, WorkflowAssigneeSummaryResponse>

PaginatedWorkflowAssigneeSummaryClient

Inherited Members

PaginatedResourceClient<WorkflowAssigneeSummary, WorkflowAssigneeSummaryResource, WorkflowAssigneeSummaryCollectionResponse, WorkflowAssigneeSummaryResponse>.PerPage(int)

PaginatedResourceClient<WorkflowAssigneeSummary, WorkflowAssigneeSummaryResource, WorkflowAssigneeSummaryCollectionResponse, WorkflowAssigneeSummaryResponse>.Offset(int)

PaginatedResourceClient<WorkflowAssigneeSummary, WorkflowAssigneeSummaryResource, WorkflowAssigneeSummaryCollectionResponse, WorkflowAssigneeSummaryResponse>.Filter(string)

PaginatedResourceClient<WorkflowAssigneeSummary, WorkflowAssigneeSummaryResource, WorkflowAssigneeSummaryCollectionResponse, WorkflowAssigneeSummaryResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<WorkflowAssigneeSummary, WorkflowAssigneeSummaryResource, WorkflowAssigneeSummaryCollectionResponse, WorkflowAssigneeSummaryResponse>.PostAsync(WorkflowAssigneeSummary, CancellationToken)

PaginatedResourceClient<WorkflowAssigneeSummary, WorkflowAssigneeSummaryResource, WorkflowAssigneeSummaryCollectionResponse, WorkflowAssigneeSummaryResponse>.PostAsync(JsonApiDocument<WorkflowAssigneeSummaryResource>, CancellationToken)

ResourceClient<WorkflowAssigneeSummary>.AddQueryParameter(string, string)

ResourceClient<WorkflowAssigneeSummary>.ReplaceQueryParameter(string, string)

ResourceClient<WorkflowAssigneeSummary>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<WorkflowAssigneeSummary>.Uri

ResourceClient<WorkflowAssigneeSummary>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedWorkflowAssigneeSummaryClient(HttpClient, Uri)

Client for interacting with WorkflowAssigneeSummary collection resources.

public PaginatedWorkflowAssigneeSummaryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedWorkflowAssigneeSummaryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedWorkflowAssigneeSummaryClient

The current PaginatedWorkflowAssigneeSummaryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedWorkflowAssigneeSummaryClient ClearParameters()

Returns

PaginatedWorkflowAssigneeSummaryClient

The current PaginatedWorkflowAssigneeSummaryClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedWorkflowAssigneeSummaryClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedWorkflowAssigneeSummaryClient

The current PaginatedWorkflowAssigneeSummaryClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of WorkflowAssigneeSummary resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowAssigneeSummaryCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedWorkflowAssigneeSummaryClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedWorkflowAssigneeSummaryClient

The current PaginatedWorkflowAssigneeSummaryClient instance.

OrderByFirstName()

Sort response items by the FirstName attribute.

public WorkflowAssigneeSummaryClient OrderByFirstName()

Returns

WorkflowAssigneeSummaryClient

OrderByFirstNameDescending()

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

public WorkflowAssigneeSummaryClient OrderByFirstNameDescending()

Returns

WorkflowAssigneeSummaryClient

OrderByLastName()

Sort response items by the LastName attribute.

public WorkflowAssigneeSummaryClient OrderByLastName()

Returns

WorkflowAssigneeSummaryClient

OrderByLastNameDescending()

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

public WorkflowAssigneeSummaryClient OrderByLastNameDescending()

Returns

WorkflowAssigneeSummaryClient

OrderByName()

Sort response items by the Name attribute.

public WorkflowAssigneeSummaryClient OrderByName()

Returns

WorkflowAssigneeSummaryClient

OrderByNameDescending()

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

public WorkflowAssigneeSummaryClient OrderByNameDescending()

Returns

WorkflowAssigneeSummaryClient

OrderByOverdueCount()

Sort response items by the OverdueCount attribute.

public WorkflowAssigneeSummaryClient OrderByOverdueCount()

Returns

WorkflowAssigneeSummaryClient

OrderByOverdueCountDescending()

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

public WorkflowAssigneeSummaryClient OrderByOverdueCountDescending()

Returns

WorkflowAssigneeSummaryClient

OrderByReadyCount()

Sort response items by the ReadyCount attribute.

public WorkflowAssigneeSummaryClient OrderByReadyCount()

Returns

WorkflowAssigneeSummaryClient

OrderByReadyCountDescending()

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

public WorkflowAssigneeSummaryClient OrderByReadyCountDescending()

Returns

WorkflowAssigneeSummaryClient

OrderBySnoozedCount()

Sort response items by the SnoozedCount attribute.

public WorkflowAssigneeSummaryClient OrderBySnoozedCount()

Returns

WorkflowAssigneeSummaryClient

OrderBySnoozedCountDescending()

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

public WorkflowAssigneeSummaryClient OrderBySnoozedCountDescending()

Returns

WorkflowAssigneeSummaryClient

PerPage(int)

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

public PaginatedWorkflowAssigneeSummaryClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedWorkflowAssigneeSummaryClient

The current PaginatedWorkflowAssigneeSummaryClient instance.

WithId(string)

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

public WorkflowAssigneeSummaryClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

WorkflowAssigneeSummaryClient

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