Class LiveClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Live resource.

public class LiveClient : SingletonResourceClient<Live, LiveResource, LiveResponse>

Inheritance

object

ResourceClient<Live>

SingletonResourceClient<Live, LiveResource, LiveResponse>

LiveClient

Inherited Members

SingletonResourceClient<Live, LiveResource, LiveResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Live, LiveResource, LiveResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Live, LiveResource, LiveResponse>.PatchAsync(Live, CancellationToken)

SingletonResourceClient<Live, LiveResource, LiveResponse>.PatchAsync(JsonApiDocument<LiveResource>, CancellationToken)

SingletonResourceClient<Live, LiveResource, LiveResponse>.DeleteAsync(CancellationToken)

ResourceClient<Live>.AddQueryParameter(string, string)

ResourceClient<Live>.ReplaceQueryParameter(string, string)

ResourceClient<Live>.AddCustomParameter(string, string)

ResourceClient<Live>.ClearParameters()

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

LiveClient(HttpClient, Uri)

Client for interacting with the Live resource.

public LiveClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Controller

Associated Controller.

public PersonClient Controller { get; }

Property Value

PersonClient

CurrentItemTime

Associated CurrentItemTime.

public ItemTimeClient CurrentItemTime { get; }

Property Value

ItemTimeClient

Items

Associated Items.

public PaginatedItemClient Items { get; }

Property Value

PaginatedItemClient

NextItemTime

Associated NextItemTime.

public ItemTimeClient NextItemTime { get; }

Property Value

ItemTimeClient

ServiceType

Associated ServiceType.

public ServiceTypeClient ServiceType { get; }

Property Value

ServiceTypeClient

WatchablePlans

Associated WatchablePlans.

public PaginatedPlanClient WatchablePlans { get; }

Property Value

PaginatedPlanClient

Methods

DeleteAsync(CancellationToken)

Deletes the Live resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the Live resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LiveResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GoToNextItemAsync(CancellationToken)

Planning Center does not provide a description for this action.

public Task GoToNextItemAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

GoToPreviousItemAsync(CancellationToken)

Planning Center does not provide a description for this action.

public Task GoToPreviousItemAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

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

PatchAsync(Live, CancellationToken)

Updates an existing Live resource asynchronously.

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

Parameters

resource Live

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LiveResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<LiveResource>, CancellationToken)

Updates an existing Live resource asynchronously.

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

Parameters

document JsonApiDocument<LiveResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LiveResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

ToggleControlAsync(CancellationToken)

Planning Center does not provide a description for this action.

public Task ToggleControlAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task