Class PaginatedResourceFolderClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ResourceFolder collection resources.

public class PaginatedResourceFolderClient : PaginatedResourceClient<ResourceFolder, ResourceFolderResource, ResourceFolderCollectionResponse, ResourceFolderResponse>

Inheritance

object

ResourceClient<ResourceFolder>

PaginatedResourceClient<ResourceFolder, ResourceFolderResource, ResourceFolderCollectionResponse, ResourceFolderResponse>

PaginatedResourceFolderClient

Inherited Members

PaginatedResourceClient<ResourceFolder, ResourceFolderResource, ResourceFolderCollectionResponse, ResourceFolderResponse>.PerPage(int)

PaginatedResourceClient<ResourceFolder, ResourceFolderResource, ResourceFolderCollectionResponse, ResourceFolderResponse>.Offset(int)

PaginatedResourceClient<ResourceFolder, ResourceFolderResource, ResourceFolderCollectionResponse, ResourceFolderResponse>.Filter(string)

PaginatedResourceClient<ResourceFolder, ResourceFolderResource, ResourceFolderCollectionResponse, ResourceFolderResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ResourceFolder, ResourceFolderResource, ResourceFolderCollectionResponse, ResourceFolderResponse>.PostAsync(ResourceFolder, CancellationToken)

PaginatedResourceClient<ResourceFolder, ResourceFolderResource, ResourceFolderCollectionResponse, ResourceFolderResponse>.PostAsync(JsonApiDocument<ResourceFolderResource>, CancellationToken)

ResourceClient<ResourceFolder>.AddQueryParameter(string, string)

ResourceClient<ResourceFolder>.ReplaceQueryParameter(string, string)

ResourceClient<ResourceFolder>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ResourceFolder>.Uri

ResourceClient<ResourceFolder>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedResourceFolderClient(HttpClient, Uri)

Client for interacting with ResourceFolder collection resources.

public PaginatedResourceFolderClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedResourceFolderClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedResourceFolderClient

The current PaginatedResourceFolderClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedResourceFolderClient ClearParameters()

Returns

PaginatedResourceFolderClient

The current PaginatedResourceFolderClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedResourceFolderClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedResourceFolderClient

The current PaginatedResourceFolderClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of ResourceFolder resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceFolderCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeResources()

Include related Resources resources in the response.

public ResourceFolderClient IncludeResources()

Returns

ResourceFolderClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedResourceFolderClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedResourceFolderClient

The current PaginatedResourceFolderClient instance.

OrderByAncestry()

Sort response items by the Ancestry attribute.

public ResourceFolderClient OrderByAncestry()

Returns

ResourceFolderClient

OrderByAncestryDescending()

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

public ResourceFolderClient OrderByAncestryDescending()

Returns

ResourceFolderClient

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public ResourceFolderClient OrderByCreatedAt()

Returns

ResourceFolderClient

OrderByCreatedAtDescending()

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

public ResourceFolderClient OrderByCreatedAtDescending()

Returns

ResourceFolderClient

OrderByName()

Sort response items by the Name attribute.

public ResourceFolderClient OrderByName()

Returns

ResourceFolderClient

OrderByNameDescending()

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

public ResourceFolderClient OrderByNameDescending()

Returns

ResourceFolderClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public ResourceFolderClient OrderByUpdatedAt()

Returns

ResourceFolderClient

OrderByUpdatedAtDescending()

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

public ResourceFolderClient OrderByUpdatedAtDescending()

Returns

ResourceFolderClient

PerPage(int)

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

public PaginatedResourceFolderClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedResourceFolderClient

The current PaginatedResourceFolderClient instance.

PostAsync(ResourceFolder, CancellationToken)

Creates a new ResourceFolder resource asynchronously.

public Task<ResourceFolderResponse> PostAsync(ResourceFolder resource, CancellationToken cancellationToken = default)

Parameters

resource ResourceFolder

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceFolderResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<ResourceFolderResource>, CancellationToken)

Creates a new ResourceFolder resource asynchronously.

public Task<ResourceFolderResponse> PostAsync(JsonApiDocument<ResourceFolderResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ResourceFolderResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceFolderResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereAncestry(string)

Query response items by the Ancestry attribute.

public ResourceFolderClient WhereAncestry(string value)

Parameters

value string

Returns

ResourceFolderClient

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public ResourceFolderClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

ResourceFolderClient

WhereName(string)

Query response items by the Name attribute.

public ResourceFolderClient WhereName(string value)

Parameters

value string

Returns

ResourceFolderClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public ResourceFolderClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

ResourceFolderClient

WithId(string)

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

public ResourceFolderClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ResourceFolderClient

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