Table of Contents

Class PaginatedLiveClient

Namespace
Crews.PlanningCenter.Api.Services.V2018_08_01
Assembly
Crews.PlanningCenter.Api.dll

Client for interacting with Live collection resources.

public class PaginatedLiveClient : PaginatedResourceClient<Live, LiveResource, LiveCollectionResponse, LiveResponse>
Inheritance
PaginatedLiveClient
Inherited Members

Constructors

PaginatedLiveClient(HttpClient, Uri)

Client for interacting with Live collection resources.

public PaginatedLiveClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient
uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Live resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LiveCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeController()

Include related Controller resources in the response.

public LiveClient IncludeController()

Returns

LiveClient

IncludeCurrentItemTime()

Include related CurrentItemTime resources in the response.

public LiveClient IncludeCurrentItemTime()

Returns

LiveClient

IncludeItems()

Include related Items resources in the response.

public LiveClient IncludeItems()

Returns

LiveClient

IncludeNextItemTime()

Include related NextItemTime resources in the response.

public LiveClient IncludeNextItemTime()

Returns

LiveClient

IncludeServiceType()

Include related ServiceType resources in the response.

public LiveClient IncludeServiceType()

Returns

LiveClient

PostAsync(Live, CancellationToken)

Creates a new Live resource asynchronously.

public Task<LiveResponse> PostAsync(Live resource, CancellationToken cancellationToken = default)

Parameters

resource Live

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LiveResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<LiveResource>, CancellationToken)

Creates a new Live resource asynchronously.

public Task<LiveResponse> PostAsync(JsonApiDocument<LiveResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<LiveResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LiveResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public LiveClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

LiveClient

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

Edit this page