Class LiveControllerClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the LiveController resource.

public class LiveControllerClient : SingletonResourceClient<LiveController, LiveControllerResource, LiveControllerResponse>

Inheritance

object

ResourceClient<LiveController>

SingletonResourceClient<LiveController, LiveControllerResource, LiveControllerResponse>

LiveControllerClient

Inherited Members

SingletonResourceClient<LiveController, LiveControllerResource, LiveControllerResponse>.GetAsync(CancellationToken)

SingletonResourceClient<LiveController, LiveControllerResource, LiveControllerResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<LiveController, LiveControllerResource, LiveControllerResponse>.PatchAsync(LiveController, CancellationToken)

SingletonResourceClient<LiveController, LiveControllerResource, LiveControllerResponse>.PatchAsync(JsonApiDocument<LiveControllerResource>, CancellationToken)

SingletonResourceClient<LiveController, LiveControllerResource, LiveControllerResponse>.DeleteAsync(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

LiveControllerClient(HttpClient, Uri)

Client for interacting with the LiveController resource.

public LiveControllerClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public LiveControllerClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

LiveControllerClient

The current LiveControllerClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public LiveControllerClient ClearParameters()

Returns

LiveControllerClient

The current LiveControllerClient instance.

GetAsync(CancellationToken)

Fetches the LiveController resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LiveControllerResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.