Class PaginatedRequiredApprovalClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2018_08_01

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>.AddCustomParameter(string, string)

ResourceClient<RequiredApproval>.ClearParameters()

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

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

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.