Class WorkflowAssigneeSummaryClient

Namespace

Crews.PlanningCenter.Api.People.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the WorkflowAssigneeSummary resource.

public class WorkflowAssigneeSummaryClient : SingletonResourceClient<WorkflowAssigneeSummary, WorkflowAssigneeSummaryResource, WorkflowAssigneeSummaryResponse>

Inheritance

object

ResourceClient<WorkflowAssigneeSummary>

SingletonResourceClient<WorkflowAssigneeSummary, WorkflowAssigneeSummaryResource, WorkflowAssigneeSummaryResponse>

WorkflowAssigneeSummaryClient

Inherited Members

SingletonResourceClient<WorkflowAssigneeSummary, WorkflowAssigneeSummaryResource, WorkflowAssigneeSummaryResponse>.GetAsync(CancellationToken)

SingletonResourceClient<WorkflowAssigneeSummary, WorkflowAssigneeSummaryResource, WorkflowAssigneeSummaryResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<WorkflowAssigneeSummary, WorkflowAssigneeSummaryResource, WorkflowAssigneeSummaryResponse>.PatchAsync(WorkflowAssigneeSummary, CancellationToken)

SingletonResourceClient<WorkflowAssigneeSummary, WorkflowAssigneeSummaryResource, WorkflowAssigneeSummaryResponse>.PatchAsync(JsonApiDocument<WorkflowAssigneeSummaryResource>, CancellationToken)

SingletonResourceClient<WorkflowAssigneeSummary, WorkflowAssigneeSummaryResource, WorkflowAssigneeSummaryResponse>.DeleteAsync(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

WorkflowAssigneeSummaryClient(HttpClient, Uri)

Client for interacting with the WorkflowAssigneeSummary resource.

public WorkflowAssigneeSummaryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public WorkflowAssigneeSummaryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

WorkflowAssigneeSummaryClient

The current WorkflowAssigneeSummaryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public WorkflowAssigneeSummaryClient ClearParameters()

Returns

WorkflowAssigneeSummaryClient

The current WorkflowAssigneeSummaryClient instance.

GetAsync(CancellationToken)

Fetches the WorkflowAssigneeSummary resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowAssigneeSummaryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.