Class PaginatedFolderPathClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with FolderPath collection resources.

public class PaginatedFolderPathClient : PaginatedResourceClient<FolderPath, FolderPathResource, FolderPathCollectionResponse, FolderPathResponse>

Inheritance

object

ResourceClient<FolderPath>

PaginatedResourceClient<FolderPath, FolderPathResource, FolderPathCollectionResponse, FolderPathResponse>

PaginatedFolderPathClient

Inherited Members

PaginatedResourceClient<FolderPath, FolderPathResource, FolderPathCollectionResponse, FolderPathResponse>.PerPage(int)

PaginatedResourceClient<FolderPath, FolderPathResource, FolderPathCollectionResponse, FolderPathResponse>.Offset(int)

PaginatedResourceClient<FolderPath, FolderPathResource, FolderPathCollectionResponse, FolderPathResponse>.Filter(string)

PaginatedResourceClient<FolderPath, FolderPathResource, FolderPathCollectionResponse, FolderPathResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<FolderPath, FolderPathResource, FolderPathCollectionResponse, FolderPathResponse>.PostAsync(FolderPath, CancellationToken)

PaginatedResourceClient<FolderPath, FolderPathResource, FolderPathCollectionResponse, FolderPathResponse>.PostAsync(JsonApiDocument<FolderPathResource>, CancellationToken)

ResourceClient<FolderPath>.AddQueryParameter(string, string)

ResourceClient<FolderPath>.ReplaceQueryParameter(string, string)

ResourceClient<FolderPath>.AddCustomParameter(string, string)

ResourceClient<FolderPath>.ClearParameters()

ResourceClient<FolderPath>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FolderPath>.Uri

ResourceClient<FolderPath>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedFolderPathClient(HttpClient, Uri)

Client for interacting with FolderPath collection resources.

public PaginatedFolderPathClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of FolderPath resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FolderPathCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public FolderPathClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

FolderPathClient

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