Class AppClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_28

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the App resource.

public class AppClient : SingletonResourceClient<App, AppResource, AppResponse>

Inheritance

object

ResourceClient<App>

SingletonResourceClient<App, AppResource, AppResponse>

AppClient

Inherited Members

SingletonResourceClient<App, AppResource, AppResponse>.GetAsync(CancellationToken)

SingletonResourceClient<App, AppResource, AppResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<App, AppResource, AppResponse>.PatchAsync(App, CancellationToken)

SingletonResourceClient<App, AppResource, AppResponse>.PatchAsync(JsonApiDocument<AppResource>, CancellationToken)

SingletonResourceClient<App, AppResource, AppResponse>.DeleteAsync(CancellationToken)

ResourceClient<App>.AddQueryParameter(string, string)

ResourceClient<App>.ReplaceQueryParameter(string, string)

ResourceClient<App>.AddCustomParameter(string, string)

ResourceClient<App>.ClearParameters()

ResourceClient<App>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<App>.Uri

ResourceClient<App>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AppClient(HttpClient, Uri)

Client for interacting with the App resource.

public AppClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches the App resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AppResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.