Class WorkflowShareClient

Namespace

Crews.PlanningCenter.Api.People.V2025_07_17

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the WorkflowShare resource.

public class WorkflowShareClient : SingletonResourceClient<WorkflowShare, WorkflowShareResource, WorkflowShareResponse>

Inheritance

object

ResourceClient<WorkflowShare>

SingletonResourceClient<WorkflowShare, WorkflowShareResource, WorkflowShareResponse>

WorkflowShareClient

Inherited Members

SingletonResourceClient<WorkflowShare, WorkflowShareResource, WorkflowShareResponse>.GetAsync(CancellationToken)

SingletonResourceClient<WorkflowShare, WorkflowShareResource, WorkflowShareResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<WorkflowShare, WorkflowShareResource, WorkflowShareResponse>.PatchAsync(WorkflowShare, CancellationToken)

SingletonResourceClient<WorkflowShare, WorkflowShareResource, WorkflowShareResponse>.PatchAsync(JsonApiDocument<WorkflowShareResource>, CancellationToken)

SingletonResourceClient<WorkflowShare, WorkflowShareResource, WorkflowShareResponse>.DeleteAsync(CancellationToken)

ResourceClient<WorkflowShare>.AddQueryParameter(string, string)

ResourceClient<WorkflowShare>.ReplaceQueryParameter(string, string)

ResourceClient<WorkflowShare>.AddCustomParameter(string, string)

ResourceClient<WorkflowShare>.ClearParameters()

ResourceClient<WorkflowShare>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<WorkflowShare>.Uri

ResourceClient<WorkflowShare>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

WorkflowShareClient(HttpClient, Uri)

Client for interacting with the WorkflowShare resource.

public WorkflowShareClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Methods

DeleteAsync(CancellationToken)

Deletes the WorkflowShare resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the WorkflowShare resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowShareResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePerson()

Include related Person resources in the response.

public WorkflowShareClient IncludePerson()

Returns

WorkflowShareClient

PatchAsync(WorkflowShare, CancellationToken)

Updates an existing WorkflowShare resource asynchronously.

public Task<WorkflowShareResponse> PatchAsync(WorkflowShare resource, CancellationToken cancellationToken = default)

Parameters

resource WorkflowShare

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowShareResponse>

A task representing the asynchronous operation, containing the updated WorkflowShare resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<WorkflowShareResource>, CancellationToken)

Updates an existing WorkflowShare resource asynchronously.

public Task<WorkflowShareResponse> PatchAsync(JsonApiDocument<WorkflowShareResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<WorkflowShareResource>

The JSON:API document to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowShareResponse>

A task representing the asynchronous operation, containing the updated WorkflowShare resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.