Class WorkflowAssigneeWorkflowSummaryClient

Namespace

Crews.PlanningCenter.Api.People.V2021_08_17

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the WorkflowAssigneeWorkflowSummary resource.

public class WorkflowAssigneeWorkflowSummaryClient : SingletonResourceClient<WorkflowAssigneeWorkflowSummary, WorkflowAssigneeWorkflowSummaryResource, WorkflowAssigneeWorkflowSummaryResponse>

Inheritance

object

ResourceClient<WorkflowAssigneeWorkflowSummary>

SingletonResourceClient<WorkflowAssigneeWorkflowSummary, WorkflowAssigneeWorkflowSummaryResource, WorkflowAssigneeWorkflowSummaryResponse>

WorkflowAssigneeWorkflowSummaryClient

Inherited Members

SingletonResourceClient<WorkflowAssigneeWorkflowSummary, WorkflowAssigneeWorkflowSummaryResource, WorkflowAssigneeWorkflowSummaryResponse>.GetAsync(CancellationToken)

SingletonResourceClient<WorkflowAssigneeWorkflowSummary, WorkflowAssigneeWorkflowSummaryResource, WorkflowAssigneeWorkflowSummaryResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<WorkflowAssigneeWorkflowSummary, WorkflowAssigneeWorkflowSummaryResource, WorkflowAssigneeWorkflowSummaryResponse>.PatchAsync(WorkflowAssigneeWorkflowSummary, CancellationToken)

SingletonResourceClient<WorkflowAssigneeWorkflowSummary, WorkflowAssigneeWorkflowSummaryResource, WorkflowAssigneeWorkflowSummaryResponse>.PatchAsync(JsonApiDocument<WorkflowAssigneeWorkflowSummaryResource>, CancellationToken)

SingletonResourceClient<WorkflowAssigneeWorkflowSummary, WorkflowAssigneeWorkflowSummaryResource, WorkflowAssigneeWorkflowSummaryResponse>.DeleteAsync(CancellationToken)

ResourceClient<WorkflowAssigneeWorkflowSummary>.AddQueryParameter(string, string)

ResourceClient<WorkflowAssigneeWorkflowSummary>.ReplaceQueryParameter(string, string)

ResourceClient<WorkflowAssigneeWorkflowSummary>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<WorkflowAssigneeWorkflowSummary>.Uri

ResourceClient<WorkflowAssigneeWorkflowSummary>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

WorkflowAssigneeWorkflowSummaryClient(HttpClient, Uri)

Client for interacting with the WorkflowAssigneeWorkflowSummary resource.

public WorkflowAssigneeWorkflowSummaryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public WorkflowAssigneeWorkflowSummaryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

WorkflowAssigneeWorkflowSummaryClient

The current WorkflowAssigneeWorkflowSummaryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public WorkflowAssigneeWorkflowSummaryClient ClearParameters()

Returns

WorkflowAssigneeWorkflowSummaryClient

The current WorkflowAssigneeWorkflowSummaryClient instance.

GetAsync(CancellationToken)

Fetches the WorkflowAssigneeWorkflowSummary resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowAssigneeWorkflowSummaryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.