Class ListStarClient

Namespace

Crews.PlanningCenter.Api.People.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ListStar resource.

public class ListStarClient : SingletonResourceClient<ListStar, ListStarResource, ListStarResponse>

Inheritance

object

ResourceClient<ListStar>

SingletonResourceClient<ListStar, ListStarResource, ListStarResponse>

ListStarClient

Inherited Members

SingletonResourceClient<ListStar, ListStarResource, ListStarResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ListStar, ListStarResource, ListStarResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ListStar, ListStarResource, ListStarResponse>.PatchAsync(ListStar, CancellationToken)

SingletonResourceClient<ListStar, ListStarResource, ListStarResponse>.PatchAsync(JsonApiDocument<ListStarResource>, CancellationToken)

SingletonResourceClient<ListStar, ListStarResource, ListStarResponse>.DeleteAsync(CancellationToken)

ResourceClient<ListStar>.AddQueryParameter(string, string)

ResourceClient<ListStar>.ReplaceQueryParameter(string, string)

ResourceClient<ListStar>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ListStar>.Uri

ResourceClient<ListStar>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ListStarClient(HttpClient, Uri)

Client for interacting with the ListStar resource.

public ListStarClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ListStarClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ListStarClient

The current ListStarClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ListStarClient ClearParameters()

Returns

ListStarClient

The current ListStarClient instance.

DeleteAsync(CancellationToken)

Deletes the ListStar 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 ListStar resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListStarResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.