Class PaginatedLiveControllerClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with LiveController collection resources.

public class PaginatedLiveControllerClient : PaginatedResourceClient<LiveController, LiveControllerResource, LiveControllerCollectionResponse, LiveControllerResponse>

Inheritance

object

ResourceClient<LiveController>

PaginatedResourceClient<LiveController, LiveControllerResource, LiveControllerCollectionResponse, LiveControllerResponse>

PaginatedLiveControllerClient

Inherited Members

PaginatedResourceClient<LiveController, LiveControllerResource, LiveControllerCollectionResponse, LiveControllerResponse>.PerPage(int)

PaginatedResourceClient<LiveController, LiveControllerResource, LiveControllerCollectionResponse, LiveControllerResponse>.Offset(int)

PaginatedResourceClient<LiveController, LiveControllerResource, LiveControllerCollectionResponse, LiveControllerResponse>.Filter(string)

PaginatedResourceClient<LiveController, LiveControllerResource, LiveControllerCollectionResponse, LiveControllerResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<LiveController, LiveControllerResource, LiveControllerCollectionResponse, LiveControllerResponse>.PostAsync(LiveController, CancellationToken)

PaginatedResourceClient<LiveController, LiveControllerResource, LiveControllerCollectionResponse, LiveControllerResponse>.PostAsync(JsonApiDocument<LiveControllerResource>, CancellationToken)

ResourceClient<LiveController>.AddQueryParameter(string, string)

ResourceClient<LiveController>.ReplaceQueryParameter(string, string)

ResourceClient<LiveController>.AddCustomParameter(string, string)

ResourceClient<LiveController>.ClearParameters()

ResourceClient<LiveController>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<LiveController>.Uri

ResourceClient<LiveController>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedLiveControllerClient(HttpClient, Uri)

Client for interacting with LiveController collection resources.

public PaginatedLiveControllerClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of LiveController resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LiveControllerCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public LiveControllerClient OrderByCreatedAt()

Returns

LiveControllerClient

OrderByCreatedAtDescending()

Sort response items by the CreatedAt attribute. Use reverse order.

public LiveControllerClient OrderByCreatedAtDescending()

Returns

LiveControllerClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public LiveControllerClient OrderByUpdatedAt()

Returns

LiveControllerClient

OrderByUpdatedAtDescending()

Sort response items by the UpdatedAt attribute. Use reverse order.

public LiveControllerClient OrderByUpdatedAtDescending()

Returns

LiveControllerClient

WithId(string)

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

public LiveControllerClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

LiveControllerClient

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