Class ListShareClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_28

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ListShare resource.

public class ListShareClient : SingletonResourceClient<ListShare, ListShareResource, ListShareResponse>

Inheritance

object

ResourceClient<ListShare>

SingletonResourceClient<ListShare, ListShareResource, ListShareResponse>

ListShareClient

Inherited Members

SingletonResourceClient<ListShare, ListShareResource, ListShareResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ListShare, ListShareResource, ListShareResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ListShare, ListShareResource, ListShareResponse>.PatchAsync(ListShare, CancellationToken)

SingletonResourceClient<ListShare, ListShareResource, ListShareResponse>.PatchAsync(JsonApiDocument<ListShareResource>, CancellationToken)

SingletonResourceClient<ListShare, ListShareResource, ListShareResponse>.DeleteAsync(CancellationToken)

ResourceClient<ListShare>.AddQueryParameter(string, string)

ResourceClient<ListShare>.ReplaceQueryParameter(string, string)

ResourceClient<ListShare>.AddCustomParameter(string, string)

ResourceClient<ListShare>.ClearParameters()

ResourceClient<ListShare>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ListShare>.Uri

ResourceClient<ListShare>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ListShareClient(HttpClient, Uri)

Client for interacting with the ListShare resource.

public ListShareClient(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 ListShare 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 ListShare resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListShareResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePerson()

Include related Person resources in the response.

public ListShareClient IncludePerson()

Returns

ListShareClient

PatchAsync(ListShare, CancellationToken)

Updates an existing ListShare resource asynchronously.

public Task<ListShareResponse> PatchAsync(ListShare resource, CancellationToken cancellationToken = default)

Parameters

resource ListShare

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListShareResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<ListShareResource>, CancellationToken)

Updates an existing ListShare resource asynchronously.

public Task<ListShareResponse> PatchAsync(JsonApiDocument<ListShareResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ListShareResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListShareResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.