Class WorkflowStepAssigneeSummaryClient

Namespace

Crews.PlanningCenter.Api.People.V2023_02_15

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the WorkflowStepAssigneeSummary resource.

public class WorkflowStepAssigneeSummaryClient : SingletonResourceClient<WorkflowStepAssigneeSummary, WorkflowStepAssigneeSummaryResource, WorkflowStepAssigneeSummaryResponse>

Inheritance

object

ResourceClient<WorkflowStepAssigneeSummary>

SingletonResourceClient<WorkflowStepAssigneeSummary, WorkflowStepAssigneeSummaryResource, WorkflowStepAssigneeSummaryResponse>

WorkflowStepAssigneeSummaryClient

Inherited Members

SingletonResourceClient<WorkflowStepAssigneeSummary, WorkflowStepAssigneeSummaryResource, WorkflowStepAssigneeSummaryResponse>.GetAsync(CancellationToken)

SingletonResourceClient<WorkflowStepAssigneeSummary, WorkflowStepAssigneeSummaryResource, WorkflowStepAssigneeSummaryResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<WorkflowStepAssigneeSummary, WorkflowStepAssigneeSummaryResource, WorkflowStepAssigneeSummaryResponse>.PatchAsync(WorkflowStepAssigneeSummary, CancellationToken)

SingletonResourceClient<WorkflowStepAssigneeSummary, WorkflowStepAssigneeSummaryResource, WorkflowStepAssigneeSummaryResponse>.PatchAsync(JsonApiDocument<WorkflowStepAssigneeSummaryResource>, CancellationToken)

SingletonResourceClient<WorkflowStepAssigneeSummary, WorkflowStepAssigneeSummaryResource, WorkflowStepAssigneeSummaryResponse>.DeleteAsync(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

WorkflowStepAssigneeSummaryClient(HttpClient, Uri)

Client for interacting with the WorkflowStepAssigneeSummary resource.

public WorkflowStepAssigneeSummaryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public WorkflowStepAssigneeSummaryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

WorkflowStepAssigneeSummaryClient

The current WorkflowStepAssigneeSummaryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public WorkflowStepAssigneeSummaryClient ClearParameters()

Returns

WorkflowStepAssigneeSummaryClient

The current WorkflowStepAssigneeSummaryClient instance.

GetAsync(CancellationToken)

Fetches the WorkflowStepAssigneeSummary resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowStepAssigneeSummaryResponse>

A task representing the asynchronous operation, containing the WorkflowStepAssigneeSummary resource.

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