Class PaginatedInactiveReasonClient

Namespace

Crews.PlanningCenter.Api.People.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with InactiveReason collection resources.

public class PaginatedInactiveReasonClient : PaginatedResourceClient<InactiveReason, InactiveReasonResource, InactiveReasonCollectionResponse, InactiveReasonResponse>

Inheritance

object

ResourceClient<InactiveReason>

PaginatedResourceClient<InactiveReason, InactiveReasonResource, InactiveReasonCollectionResponse, InactiveReasonResponse>

PaginatedInactiveReasonClient

Inherited Members

PaginatedResourceClient<InactiveReason, InactiveReasonResource, InactiveReasonCollectionResponse, InactiveReasonResponse>.PerPage(int)

PaginatedResourceClient<InactiveReason, InactiveReasonResource, InactiveReasonCollectionResponse, InactiveReasonResponse>.Offset(int)

PaginatedResourceClient<InactiveReason, InactiveReasonResource, InactiveReasonCollectionResponse, InactiveReasonResponse>.Filter(string)

PaginatedResourceClient<InactiveReason, InactiveReasonResource, InactiveReasonCollectionResponse, InactiveReasonResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<InactiveReason, InactiveReasonResource, InactiveReasonCollectionResponse, InactiveReasonResponse>.PostAsync(InactiveReason, CancellationToken)

PaginatedResourceClient<InactiveReason, InactiveReasonResource, InactiveReasonCollectionResponse, InactiveReasonResponse>.PostAsync(JsonApiDocument<InactiveReasonResource>, CancellationToken)

ResourceClient<InactiveReason>.AddQueryParameter(string, string)

ResourceClient<InactiveReason>.ReplaceQueryParameter(string, string)

ResourceClient<InactiveReason>.AddCustomParameter(string, string)

ResourceClient<InactiveReason>.ClearParameters()

ResourceClient<InactiveReason>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<InactiveReason>.Uri

ResourceClient<InactiveReason>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedInactiveReasonClient(HttpClient, Uri)

Client for interacting with InactiveReason collection resources.

public PaginatedInactiveReasonClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of InactiveReason resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<InactiveReasonCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderByValue()

Sort response items by the Value attribute.

public InactiveReasonClient OrderByValue()

Returns

InactiveReasonClient

OrderByValueDescending()

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

public InactiveReasonClient OrderByValueDescending()

Returns

InactiveReasonClient

PostAsync(InactiveReason, CancellationToken)

Creates a new InactiveReason resource asynchronously.

public Task<InactiveReasonResponse> PostAsync(InactiveReason resource, CancellationToken cancellationToken = default)

Parameters

resource InactiveReason

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<InactiveReasonResponse>

A task representing the asynchronous operation, containing the created InactiveReason resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<InactiveReasonResource>, CancellationToken)

Creates a new InactiveReason resource asynchronously.

public Task<InactiveReasonResponse> PostAsync(JsonApiDocument<InactiveReasonResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<InactiveReasonResource>

The JSON:API document to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<InactiveReasonResponse>

A task representing the asynchronous operation, containing the created InactiveReason resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereValue(string)

Query response items by the Value attribute.

public InactiveReasonClient WhereValue(string value)

Parameters

value string

Returns

InactiveReasonClient

WithId(string)

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

public InactiveReasonClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

InactiveReasonClient

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