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

object

ResourceClient<Live>

PaginatedResourceClient<Live, LiveResource, LiveCollectionResponse, LiveResponse>

PaginatedLiveClient

Inherited Members

PaginatedResourceClient<Live, LiveResource, LiveCollectionResponse, LiveResponse>.PerPage(int)

PaginatedResourceClient<Live, LiveResource, LiveCollectionResponse, LiveResponse>.Offset(int)

PaginatedResourceClient<Live, LiveResource, LiveCollectionResponse, LiveResponse>.Filter(string)

PaginatedResourceClient<Live, LiveResource, LiveCollectionResponse, LiveResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Live, LiveResource, LiveCollectionResponse, LiveResponse>.PostAsync(Live, CancellationToken)

PaginatedResourceClient<Live, LiveResource, LiveCollectionResponse, LiveResponse>.PostAsync(JsonApiDocument<LiveResource>, CancellationToken)

ResourceClient<Live>.AddQueryParameter(string, string)

ResourceClient<Live>.ReplaceQueryParameter(string, string)

ResourceClient<Live>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Live>.Uri

ResourceClient<Live>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedLiveClient(HttpClient, Uri)

Client for interacting with Live collection resources.

public PaginatedLiveClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedLiveClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedLiveClient

The current PaginatedLiveClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedLiveClient ClearParameters()

Returns

PaginatedLiveClient

The current PaginatedLiveClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedLiveClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedLiveClient

The current PaginatedLiveClient instance.

Remarks

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

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedLiveClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedLiveClient

The current PaginatedLiveClient instance.

PerPage(int)

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

public PaginatedLiveClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedLiveClient

The current PaginatedLiveClient instance.

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.