Class RuleClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Rule resource.

public class RuleClient : SingletonResourceClient<Rule, RuleResource, RuleResponse>

Inheritance

object

ResourceClient<Rule>

SingletonResourceClient<Rule, RuleResource, RuleResponse>

RuleClient

Inherited Members

SingletonResourceClient<Rule, RuleResource, RuleResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Rule, RuleResource, RuleResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Rule, RuleResource, RuleResponse>.PatchAsync(Rule, CancellationToken)

SingletonResourceClient<Rule, RuleResource, RuleResponse>.PatchAsync(JsonApiDocument<RuleResource>, CancellationToken)

SingletonResourceClient<Rule, RuleResource, RuleResponse>.DeleteAsync(CancellationToken)

ResourceClient<Rule>.AddQueryParameter(string, string)

ResourceClient<Rule>.ReplaceQueryParameter(string, string)

ResourceClient<Rule>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Rule>.Uri

ResourceClient<Rule>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

RuleClient(HttpClient, Uri)

Client for interacting with the Rule resource.

public RuleClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Conditions

Associated Conditions.

public PaginatedConditionClient Conditions { get; }

Property Value

PaginatedConditionClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public RuleClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

RuleClient

The current RuleClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public RuleClient ClearParameters()

Returns

RuleClient

The current RuleClient instance.

GetAsync(CancellationToken)

Fetches the Rule resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RuleResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeConditions()

Include related Conditions resources in the response.

public RuleClient IncludeConditions()

Returns

RuleClient