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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedFolderPathClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedFolderPathClient

The current PaginatedFolderPathClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedFolderPathClient ClearParameters()

Returns

PaginatedFolderPathClient

The current PaginatedFolderPathClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedFolderPathClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedFolderPathClient

The current PaginatedFolderPathClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedFolderPathClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedFolderPathClient

The current PaginatedFolderPathClient instance.

PerPage(int)

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

public PaginatedFolderPathClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedFolderPathClient

The current PaginatedFolderPathClient instance.

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.