Class ConnectedApplicationClient

Namespace

Crews.PlanningCenter.Api.Api.V2019_02_13

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ConnectedApplication resource.

public class ConnectedApplicationClient : SingletonResourceClient<ConnectedApplication, ConnectedApplicationResource, ConnectedApplicationResponse>

Inheritance

object

ResourceClient<ConnectedApplication>

SingletonResourceClient<ConnectedApplication, ConnectedApplicationResource, ConnectedApplicationResponse>

ConnectedApplicationClient

Inherited Members

SingletonResourceClient<ConnectedApplication, ConnectedApplicationResource, ConnectedApplicationResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ConnectedApplication, ConnectedApplicationResource, ConnectedApplicationResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ConnectedApplication, ConnectedApplicationResource, ConnectedApplicationResponse>.PatchAsync(ConnectedApplication, CancellationToken)

SingletonResourceClient<ConnectedApplication, ConnectedApplicationResource, ConnectedApplicationResponse>.PatchAsync(JsonApiDocument<ConnectedApplicationResource>, CancellationToken)

SingletonResourceClient<ConnectedApplication, ConnectedApplicationResource, ConnectedApplicationResponse>.DeleteAsync(CancellationToken)

ResourceClient<ConnectedApplication>.AddQueryParameter(string, string)

ResourceClient<ConnectedApplication>.ReplaceQueryParameter(string, string)

ResourceClient<ConnectedApplication>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ConnectedApplication>.Uri

ResourceClient<ConnectedApplication>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ConnectedApplicationClient(HttpClient, Uri)

Client for interacting with the ConnectedApplication resource.

public ConnectedApplicationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

People

Associated People.

public PaginatedConnectedApplicationPersonClient People { get; }

Property Value

PaginatedConnectedApplicationPersonClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ConnectedApplicationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ConnectedApplicationClient

The current ConnectedApplicationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ConnectedApplicationClient ClearParameters()

Returns

ConnectedApplicationClient

The current ConnectedApplicationClient instance.

GetAsync(CancellationToken)

Fetches the ConnectedApplication resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ConnectedApplicationResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.