Class PaginatedWorkflowStepAssigneeSummaryClient

Namespace

Crews.PlanningCenter.Api.People.V2020_07_22

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>.AddCustomParameter(string, string)

ResourceClient<WorkflowStepAssigneeSummary>.ClearParameters()

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

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

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.