Class PaginatedRuleClient

Namespace

Crews.PlanningCenter.Api.People.V2025_07_02

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Rule collection resources.

public class PaginatedRuleClient : PaginatedResourceClient<Rule, RuleResource, RuleCollectionResponse, RuleResponse>

Inheritance

object

ResourceClient<Rule>

PaginatedResourceClient<Rule, RuleResource, RuleCollectionResponse, RuleResponse>

PaginatedRuleClient

Inherited Members

PaginatedResourceClient<Rule, RuleResource, RuleCollectionResponse, RuleResponse>.PerPage(int)

PaginatedResourceClient<Rule, RuleResource, RuleCollectionResponse, RuleResponse>.Offset(int)

PaginatedResourceClient<Rule, RuleResource, RuleCollectionResponse, RuleResponse>.Filter(string)

PaginatedResourceClient<Rule, RuleResource, RuleCollectionResponse, RuleResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Rule, RuleResource, RuleCollectionResponse, RuleResponse>.PostAsync(Rule, CancellationToken)

PaginatedResourceClient<Rule, RuleResource, RuleCollectionResponse, RuleResponse>.PostAsync(JsonApiDocument<RuleResource>, 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

PaginatedRuleClient(HttpClient, Uri)

Client for interacting with Rule collection resources.

public PaginatedRuleClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedRuleClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedRuleClient

The current PaginatedRuleClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedRuleClient ClearParameters()

Returns

PaginatedRuleClient

The current PaginatedRuleClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedRuleClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedRuleClient

The current PaginatedRuleClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

GetAsync(CancellationToken)

Fetches a paginated list of Rule resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RuleCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of Rule resources.

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedRuleClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedRuleClient

The current PaginatedRuleClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public RuleClient OrderByCreatedAt()

Returns

RuleClient

OrderByCreatedAtDescending()

Sort response items by the CreatedAt attribute. Use reverse order.

public RuleClient OrderByCreatedAtDescending()

Returns

RuleClient

OrderBySubset()

Sort response items by the Subset attribute.

public RuleClient OrderBySubset()

Returns

RuleClient

OrderBySubsetDescending()

Sort response items by the Subset attribute. Use reverse order.

public RuleClient OrderBySubsetDescending()

Returns

RuleClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public RuleClient OrderByUpdatedAt()

Returns

RuleClient

OrderByUpdatedAtDescending()

Sort response items by the UpdatedAt attribute. Use reverse order.

public RuleClient OrderByUpdatedAtDescending()

Returns

RuleClient

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedRuleClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedRuleClient

The current PaginatedRuleClient instance.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public RuleClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

RuleClient

WhereSubset(string)

Query response items by the Subset attribute.

public RuleClient WhereSubset(string value)

Parameters

value string

Returns

RuleClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public RuleClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

RuleClient

WithId(string)

Creates a new instance of a Rule client for a specific resource ID.

public RuleClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

RuleClient

A new instance of the resource client for the specified resource ID.