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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedLiveControllerClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedLiveControllerClient

The current PaginatedLiveControllerClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedLiveControllerClient ClearParameters()

Returns

PaginatedLiveControllerClient

The current PaginatedLiveControllerClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedLiveControllerClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedLiveControllerClient

The current PaginatedLiveControllerClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedLiveControllerClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedLiveControllerClient

The current PaginatedLiveControllerClient instance.

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

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedLiveControllerClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedLiveControllerClient

The current PaginatedLiveControllerClient instance.

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.