Class PaginatedFolderClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Folder collection resources.

public class PaginatedFolderClient : PaginatedResourceClient<Folder, FolderResource, FolderCollectionResponse, FolderResponse>

Inheritance

object

ResourceClient<Folder>

PaginatedResourceClient<Folder, FolderResource, FolderCollectionResponse, FolderResponse>

PaginatedFolderClient

Inherited Members

PaginatedResourceClient<Folder, FolderResource, FolderCollectionResponse, FolderResponse>.PerPage(int)

PaginatedResourceClient<Folder, FolderResource, FolderCollectionResponse, FolderResponse>.Offset(int)

PaginatedResourceClient<Folder, FolderResource, FolderCollectionResponse, FolderResponse>.Filter(string)

PaginatedResourceClient<Folder, FolderResource, FolderCollectionResponse, FolderResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Folder, FolderResource, FolderCollectionResponse, FolderResponse>.PostAsync(Folder, CancellationToken)

PaginatedResourceClient<Folder, FolderResource, FolderCollectionResponse, FolderResponse>.PostAsync(JsonApiDocument<FolderResource>, CancellationToken)

ResourceClient<Folder>.AddQueryParameter(string, string)

ResourceClient<Folder>.ReplaceQueryParameter(string, string)

ResourceClient<Folder>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Folder>.Uri

ResourceClient<Folder>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedFolderClient(HttpClient, Uri)

Client for interacting with Folder collection resources.

public PaginatedFolderClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedFolderClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedFolderClient

The current PaginatedFolderClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedFolderClient ClearParameters()

Returns

PaginatedFolderClient

The current PaginatedFolderClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedFolderClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedFolderClient

The current PaginatedFolderClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Folder resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FolderCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeServiceTypes()

Include related ServiceTypes resources in the response.

public FolderClient IncludeServiceTypes()

Returns

FolderClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedFolderClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedFolderClient

The current PaginatedFolderClient instance.

OrderByName()

Sort response items by the Name attribute.

public FolderClient OrderByName()

Returns

FolderClient

OrderByNameDescending()

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

public FolderClient OrderByNameDescending()

Returns

FolderClient

PerPage(int)

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

public PaginatedFolderClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedFolderClient

The current PaginatedFolderClient instance.

PostAsync(Folder, CancellationToken)

Creates a new Folder resource asynchronously.

public Task<FolderResponse> PostAsync(Folder resource, CancellationToken cancellationToken = default)

Parameters

resource Folder

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FolderResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<FolderResource>, CancellationToken)

Creates a new Folder resource asynchronously.

public Task<FolderResponse> PostAsync(JsonApiDocument<FolderResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<FolderResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FolderResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereParentId(int)

Query response items by the ParentId attribute.

public FolderClient WhereParentId(int value)

Parameters

value int

Returns

FolderClient

WithId(string)

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

public FolderClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

FolderClient

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