Class PaginatedListStarClient

Namespace

Crews.PlanningCenter.Api.People.V2020_04_06

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ListStar collection resources.

public class PaginatedListStarClient : PaginatedResourceClient<ListStar, ListStarResource, ListStarCollectionResponse, ListStarResponse>

Inheritance

object

ResourceClient<ListStar>

PaginatedResourceClient<ListStar, ListStarResource, ListStarCollectionResponse, ListStarResponse>

PaginatedListStarClient

Inherited Members

PaginatedResourceClient<ListStar, ListStarResource, ListStarCollectionResponse, ListStarResponse>.PerPage(int)

PaginatedResourceClient<ListStar, ListStarResource, ListStarCollectionResponse, ListStarResponse>.Offset(int)

PaginatedResourceClient<ListStar, ListStarResource, ListStarCollectionResponse, ListStarResponse>.Filter(string)

PaginatedResourceClient<ListStar, ListStarResource, ListStarCollectionResponse, ListStarResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ListStar, ListStarResource, ListStarCollectionResponse, ListStarResponse>.PostAsync(ListStar, CancellationToken)

PaginatedResourceClient<ListStar, ListStarResource, ListStarCollectionResponse, ListStarResponse>.PostAsync(JsonApiDocument<ListStarResource>, CancellationToken)

ResourceClient<ListStar>.AddQueryParameter(string, string)

ResourceClient<ListStar>.ReplaceQueryParameter(string, string)

ResourceClient<ListStar>.AddCustomParameter(string, string)

ResourceClient<ListStar>.ClearParameters()

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

PaginatedListStarClient(HttpClient, Uri)

Client for interacting with ListStar collection resources.

public PaginatedListStarClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of ListStar resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListStarCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(ListStar, CancellationToken)

Creates a new ListStar resource asynchronously.

public Task<ListStarResponse> PostAsync(ListStar resource, CancellationToken cancellationToken = default)

Parameters

resource ListStar

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListStarResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<ListStarResource>, CancellationToken)

Creates a new ListStar resource asynchronously.

public Task<ListStarResponse> PostAsync(JsonApiDocument<ListStarResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ListStarResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListStarResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public ListStarClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ListStarClient

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