Class PaginatedWorkflowStepAssigneeSummaryClient

Namespace

Crews.PlanningCenter.Api.People.V2019_01_14

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with WorkflowStepAssigneeSummary collection resources.

public class PaginatedWorkflowStepAssigneeSummaryClient : PaginatedResourceClient<WorkflowStepAssigneeSummary, WorkflowStepAssigneeSummaryResource, WorkflowStepAssigneeSummaryCollectionResponse, WorkflowStepAssigneeSummaryResponse>

Inheritance

object

ResourceClient<WorkflowStepAssigneeSummary>

PaginatedResourceClient<WorkflowStepAssigneeSummary, WorkflowStepAssigneeSummaryResource, WorkflowStepAssigneeSummaryCollectionResponse, WorkflowStepAssigneeSummaryResponse>

PaginatedWorkflowStepAssigneeSummaryClient

Inherited Members

PaginatedResourceClient<WorkflowStepAssigneeSummary, WorkflowStepAssigneeSummaryResource, WorkflowStepAssigneeSummaryCollectionResponse, WorkflowStepAssigneeSummaryResponse>.PerPage(int)

PaginatedResourceClient<WorkflowStepAssigneeSummary, WorkflowStepAssigneeSummaryResource, WorkflowStepAssigneeSummaryCollectionResponse, WorkflowStepAssigneeSummaryResponse>.Offset(int)

PaginatedResourceClient<WorkflowStepAssigneeSummary, WorkflowStepAssigneeSummaryResource, WorkflowStepAssigneeSummaryCollectionResponse, WorkflowStepAssigneeSummaryResponse>.Filter(string)

PaginatedResourceClient<WorkflowStepAssigneeSummary, WorkflowStepAssigneeSummaryResource, WorkflowStepAssigneeSummaryCollectionResponse, WorkflowStepAssigneeSummaryResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<WorkflowStepAssigneeSummary, WorkflowStepAssigneeSummaryResource, WorkflowStepAssigneeSummaryCollectionResponse, WorkflowStepAssigneeSummaryResponse>.PostAsync(WorkflowStepAssigneeSummary, CancellationToken)

PaginatedResourceClient<WorkflowStepAssigneeSummary, WorkflowStepAssigneeSummaryResource, WorkflowStepAssigneeSummaryCollectionResponse, WorkflowStepAssigneeSummaryResponse>.PostAsync(JsonApiDocument<WorkflowStepAssigneeSummaryResource>, CancellationToken)

ResourceClient<WorkflowStepAssigneeSummary>.AddQueryParameter(string, string)

ResourceClient<WorkflowStepAssigneeSummary>.ReplaceQueryParameter(string, string)

ResourceClient<WorkflowStepAssigneeSummary>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<WorkflowStepAssigneeSummary>.Uri

ResourceClient<WorkflowStepAssigneeSummary>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedWorkflowStepAssigneeSummaryClient(HttpClient, Uri)

Client for interacting with WorkflowStepAssigneeSummary collection resources.

public PaginatedWorkflowStepAssigneeSummaryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedWorkflowStepAssigneeSummaryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedWorkflowStepAssigneeSummaryClient

The current PaginatedWorkflowStepAssigneeSummaryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedWorkflowStepAssigneeSummaryClient ClearParameters()

Returns

PaginatedWorkflowStepAssigneeSummaryClient

The current PaginatedWorkflowStepAssigneeSummaryClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedWorkflowStepAssigneeSummaryClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedWorkflowStepAssigneeSummaryClient

The current PaginatedWorkflowStepAssigneeSummaryClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of WorkflowStepAssigneeSummary resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowStepAssigneeSummaryCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePerson()

Include related Person resources in the response.

public WorkflowStepAssigneeSummaryClient IncludePerson()

Returns

WorkflowStepAssigneeSummaryClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedWorkflowStepAssigneeSummaryClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedWorkflowStepAssigneeSummaryClient

The current PaginatedWorkflowStepAssigneeSummaryClient instance.

PerPage(int)

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

public PaginatedWorkflowStepAssigneeSummaryClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedWorkflowStepAssigneeSummaryClient

The current PaginatedWorkflowStepAssigneeSummaryClient instance.

WithId(string)

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

public WorkflowStepAssigneeSummaryClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

WorkflowStepAssigneeSummaryClient

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