Class ListResultClient

Namespace

Crews.PlanningCenter.Api.People.V2023_02_15

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ListResult resource.

public class ListResultClient : SingletonResourceClient<ListResult, ListResultResource, ListResultResponse>

Inheritance

object

ResourceClient<ListResult>

SingletonResourceClient<ListResult, ListResultResource, ListResultResponse>

ListResultClient

Inherited Members

SingletonResourceClient<ListResult, ListResultResource, ListResultResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ListResult, ListResultResource, ListResultResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ListResult, ListResultResource, ListResultResponse>.PatchAsync(ListResult, CancellationToken)

SingletonResourceClient<ListResult, ListResultResource, ListResultResponse>.PatchAsync(JsonApiDocument<ListResultResource>, CancellationToken)

SingletonResourceClient<ListResult, ListResultResource, ListResultResponse>.DeleteAsync(CancellationToken)

ResourceClient<ListResult>.AddQueryParameter(string, string)

ResourceClient<ListResult>.ReplaceQueryParameter(string, string)

ResourceClient<ListResult>.AddCustomParameter(string, string)

ResourceClient<ListResult>.ClearParameters()

ResourceClient<ListResult>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ListResult>.Uri

ResourceClient<ListResult>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ListResultClient(HttpClient, Uri)

Client for interacting with the ListResult resource.

public ListResultClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches the ListResult resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListResultResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.