Class PublicViewClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PublicView resource.

public class PublicViewClient : SingletonResourceClient<PublicView, PublicViewResource, PublicViewResponse>

Inheritance

object

ResourceClient<PublicView>

SingletonResourceClient<PublicView, PublicViewResource, PublicViewResponse>

PublicViewClient

Inherited Members

SingletonResourceClient<PublicView, PublicViewResource, PublicViewResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PublicView, PublicViewResource, PublicViewResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PublicView, PublicViewResource, PublicViewResponse>.PatchAsync(PublicView, CancellationToken)

SingletonResourceClient<PublicView, PublicViewResource, PublicViewResponse>.PatchAsync(JsonApiDocument<PublicViewResource>, CancellationToken)

SingletonResourceClient<PublicView, PublicViewResource, PublicViewResponse>.DeleteAsync(CancellationToken)

ResourceClient<PublicView>.AddQueryParameter(string, string)

ResourceClient<PublicView>.ReplaceQueryParameter(string, string)

ResourceClient<PublicView>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PublicView>.Uri

ResourceClient<PublicView>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PublicViewClient(HttpClient, Uri)

Client for interacting with the PublicView resource.

public PublicViewClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PublicViewClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PublicViewClient

The current PublicViewClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PublicViewClient ClearParameters()

Returns

PublicViewClient

The current PublicViewClient instance.

GetAsync(CancellationToken)

Fetches the PublicView resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PublicViewResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.