Class PaginatedConditionClient

Namespace

Crews.PlanningCenter.Api.People.V2021_08_17

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Condition collection resources.

public class PaginatedConditionClient : PaginatedResourceClient<Condition, ConditionResource, ConditionCollectionResponse, ConditionResponse>

Inheritance

object

ResourceClient<Condition>

PaginatedResourceClient<Condition, ConditionResource, ConditionCollectionResponse, ConditionResponse>

PaginatedConditionClient

Inherited Members

PaginatedResourceClient<Condition, ConditionResource, ConditionCollectionResponse, ConditionResponse>.PerPage(int)

PaginatedResourceClient<Condition, ConditionResource, ConditionCollectionResponse, ConditionResponse>.Offset(int)

PaginatedResourceClient<Condition, ConditionResource, ConditionCollectionResponse, ConditionResponse>.Filter(string)

PaginatedResourceClient<Condition, ConditionResource, ConditionCollectionResponse, ConditionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Condition, ConditionResource, ConditionCollectionResponse, ConditionResponse>.PostAsync(Condition, CancellationToken)

PaginatedResourceClient<Condition, ConditionResource, ConditionCollectionResponse, ConditionResponse>.PostAsync(JsonApiDocument<ConditionResource>, CancellationToken)

ResourceClient<Condition>.AddQueryParameter(string, string)

ResourceClient<Condition>.ReplaceQueryParameter(string, string)

ResourceClient<Condition>.AddCustomParameter(string, string)

ResourceClient<Condition>.ClearParameters()

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

PaginatedConditionClient(HttpClient, Uri)

Client for interacting with Condition collection resources.

public PaginatedConditionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Condition resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ConditionCollectionResponse>

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

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

OrderByApplication()

Sort response items by the Application attribute.

public ConditionClient OrderByApplication()

Returns

ConditionClient

OrderByApplicationDescending()

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

public ConditionClient OrderByApplicationDescending()

Returns

ConditionClient

OrderByComparison()

Sort response items by the Comparison attribute.

public ConditionClient OrderByComparison()

Returns

ConditionClient

OrderByComparisonDescending()

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

public ConditionClient OrderByComparisonDescending()

Returns

ConditionClient

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public ConditionClient OrderByCreatedAt()

Returns

ConditionClient

OrderByCreatedAtDescending()

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

public ConditionClient OrderByCreatedAtDescending()

Returns

ConditionClient

OrderByDefinitionClass()

Sort response items by the DefinitionClass attribute.

public ConditionClient OrderByDefinitionClass()

Returns

ConditionClient

OrderByDefinitionClassDescending()

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

public ConditionClient OrderByDefinitionClassDescending()

Returns

ConditionClient

OrderByDefinitionIdentifier()

Sort response items by the DefinitionIdentifier attribute.

public ConditionClient OrderByDefinitionIdentifier()

Returns

ConditionClient

OrderByDefinitionIdentifierDescending()

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

public ConditionClient OrderByDefinitionIdentifierDescending()

Returns

ConditionClient

OrderByDescription()

Sort response items by the Description attribute.

public ConditionClient OrderByDescription()

Returns

ConditionClient

OrderByDescriptionDescending()

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

public ConditionClient OrderByDescriptionDescending()

Returns

ConditionClient

OrderBySettings()

Sort response items by the Settings attribute.

public ConditionClient OrderBySettings()

Returns

ConditionClient

OrderBySettingsDescending()

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

public ConditionClient OrderBySettingsDescending()

Returns

ConditionClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public ConditionClient OrderByUpdatedAt()

Returns

ConditionClient

OrderByUpdatedAtDescending()

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

public ConditionClient OrderByUpdatedAtDescending()

Returns

ConditionClient

WhereApplication(string)

Query response items by the Application attribute.

public ConditionClient WhereApplication(string value)

Parameters

value string

Returns

ConditionClient

WhereComparison(string)

Query response items by the Comparison attribute.

public ConditionClient WhereComparison(string value)

Parameters

value string

Returns

ConditionClient

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public ConditionClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

ConditionClient

WhereDefinitionClass(string)

Query response items by the DefinitionClass attribute.

public ConditionClient WhereDefinitionClass(string value)

Parameters

value string

Returns

ConditionClient

WhereDefinitionIdentifier(string)

Query response items by the DefinitionIdentifier attribute.

public ConditionClient WhereDefinitionIdentifier(string value)

Parameters

value string

Returns

ConditionClient

WhereDescription(string)

Query response items by the Description attribute.

public ConditionClient WhereDescription(string value)

Parameters

value string

Returns

ConditionClient

WhereSettings(string)

Query response items by the Settings attribute.

public ConditionClient WhereSettings(string value)

Parameters

value string

Returns

ConditionClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public ConditionClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

ConditionClient

WithId(string)

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

public ConditionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ConditionClient

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