Class ConditionClient

Namespace

Crews.PlanningCenter.Api.People.V2020_04_06

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Condition resource.

public class ConditionClient : SingletonResourceClient<Condition, ConditionResource, ConditionResponse>

Inheritance

object

ResourceClient<Condition>

SingletonResourceClient<Condition, ConditionResource, ConditionResponse>

ConditionClient

Inherited Members

SingletonResourceClient<Condition, ConditionResource, ConditionResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Condition, ConditionResource, ConditionResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Condition, ConditionResource, ConditionResponse>.PatchAsync(Condition, CancellationToken)

SingletonResourceClient<Condition, ConditionResource, ConditionResponse>.PatchAsync(JsonApiDocument<ConditionResource>, CancellationToken)

SingletonResourceClient<Condition, ConditionResource, ConditionResponse>.DeleteAsync(CancellationToken)

ResourceClient<Condition>.AddQueryParameter(string, string)

ResourceClient<Condition>.ReplaceQueryParameter(string, string)

ResourceClient<Condition>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Condition>.Uri

ResourceClient<Condition>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ConditionClient(HttpClient, Uri)

Client for interacting with the Condition resource.

public ConditionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

CreatedBy

Associated CreatedBy.

public PersonClient CreatedBy { get; }

Property Value

PersonClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ConditionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ConditionClient

The current ConditionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ConditionClient ClearParameters()

Returns

ConditionClient

The current ConditionClient instance.

GetAsync(CancellationToken)

Fetches the Condition resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ConditionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCreatedBy()

Include related CreatedBy resources in the response.

public ConditionClient IncludeCreatedBy()

Returns

ConditionClient