Class PaginatedRequiredApprovalClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2021_07_20

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with RequiredApproval collection resources.

public class PaginatedRequiredApprovalClient : PaginatedResourceClient<RequiredApproval, RequiredApprovalResource, RequiredApprovalCollectionResponse, RequiredApprovalResponse>

Inheritance

object

ResourceClient<RequiredApproval>

PaginatedResourceClient<RequiredApproval, RequiredApprovalResource, RequiredApprovalCollectionResponse, RequiredApprovalResponse>

PaginatedRequiredApprovalClient

Inherited Members

PaginatedResourceClient<RequiredApproval, RequiredApprovalResource, RequiredApprovalCollectionResponse, RequiredApprovalResponse>.PerPage(int)

PaginatedResourceClient<RequiredApproval, RequiredApprovalResource, RequiredApprovalCollectionResponse, RequiredApprovalResponse>.Offset(int)

PaginatedResourceClient<RequiredApproval, RequiredApprovalResource, RequiredApprovalCollectionResponse, RequiredApprovalResponse>.Filter(string)

PaginatedResourceClient<RequiredApproval, RequiredApprovalResource, RequiredApprovalCollectionResponse, RequiredApprovalResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<RequiredApproval, RequiredApprovalResource, RequiredApprovalCollectionResponse, RequiredApprovalResponse>.PostAsync(RequiredApproval, CancellationToken)

PaginatedResourceClient<RequiredApproval, RequiredApprovalResource, RequiredApprovalCollectionResponse, RequiredApprovalResponse>.PostAsync(JsonApiDocument<RequiredApprovalResource>, CancellationToken)

ResourceClient<RequiredApproval>.AddQueryParameter(string, string)

ResourceClient<RequiredApproval>.ReplaceQueryParameter(string, string)

ResourceClient<RequiredApproval>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<RequiredApproval>.Uri

ResourceClient<RequiredApproval>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedRequiredApprovalClient(HttpClient, Uri)

Client for interacting with RequiredApproval collection resources.

public PaginatedRequiredApprovalClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedRequiredApprovalClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedRequiredApprovalClient

The current PaginatedRequiredApprovalClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedRequiredApprovalClient ClearParameters()

Returns

PaginatedRequiredApprovalClient

The current PaginatedRequiredApprovalClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedRequiredApprovalClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedRequiredApprovalClient

The current PaginatedRequiredApprovalClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of RequiredApproval resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RequiredApprovalCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeResource()

Include related Resource resources in the response.

public RequiredApprovalClient IncludeResource()

Returns

RequiredApprovalClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedRequiredApprovalClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedRequiredApprovalClient

The current PaginatedRequiredApprovalClient instance.

PerPage(int)

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

public PaginatedRequiredApprovalClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedRequiredApprovalClient

The current PaginatedRequiredApprovalClient instance.

WithId(string)

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

public RequiredApprovalClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

RequiredApprovalClient

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