Class PaginatedWorkflowShareClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_28

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with WorkflowShare collection resources.

public class PaginatedWorkflowShareClient : PaginatedResourceClient<WorkflowShare, WorkflowShareResource, WorkflowShareCollectionResponse, WorkflowShareResponse>

Inheritance

object

ResourceClient<WorkflowShare>

PaginatedResourceClient<WorkflowShare, WorkflowShareResource, WorkflowShareCollectionResponse, WorkflowShareResponse>

PaginatedWorkflowShareClient

Inherited Members

PaginatedResourceClient<WorkflowShare, WorkflowShareResource, WorkflowShareCollectionResponse, WorkflowShareResponse>.PerPage(int)

PaginatedResourceClient<WorkflowShare, WorkflowShareResource, WorkflowShareCollectionResponse, WorkflowShareResponse>.Offset(int)

PaginatedResourceClient<WorkflowShare, WorkflowShareResource, WorkflowShareCollectionResponse, WorkflowShareResponse>.Filter(string)

PaginatedResourceClient<WorkflowShare, WorkflowShareResource, WorkflowShareCollectionResponse, WorkflowShareResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<WorkflowShare, WorkflowShareResource, WorkflowShareCollectionResponse, WorkflowShareResponse>.PostAsync(WorkflowShare, CancellationToken)

PaginatedResourceClient<WorkflowShare, WorkflowShareResource, WorkflowShareCollectionResponse, WorkflowShareResponse>.PostAsync(JsonApiDocument<WorkflowShareResource>, 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

PaginatedWorkflowShareClient(HttpClient, Uri)

Client for interacting with WorkflowShare collection resources.

public PaginatedWorkflowShareClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of WorkflowShare resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowShareCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of WorkflowShare resources.

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

PostAsync(WorkflowShare, CancellationToken)

Creates a new WorkflowShare resource asynchronously.

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

Parameters

resource WorkflowShare

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowShareResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<WorkflowShareResource>, CancellationToken)

Creates a new WorkflowShare resource asynchronously.

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

Parameters

document JsonApiDocument<WorkflowShareResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowShareResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WherePermission(string)

Query response items by the Permission attribute.

public WorkflowShareClient WherePermission(string value)

Parameters

value string

Returns

WorkflowShareClient

WithId(string)

Creates a new instance of a WorkflowShare client for a specific resource ID.

public WorkflowShareClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

WorkflowShareClient

A new instance of the resource client for the specified resource ID.