Class PaginatedListClient

Namespace

Crews.PlanningCenter.Api.People.V2023_02_15

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with List collection resources.

public class PaginatedListClient : PaginatedResourceClient<List, ListResource, ListCollectionResponse, ListResponse>

Inheritance

object

ResourceClient<List>

PaginatedResourceClient<List, ListResource, ListCollectionResponse, ListResponse>

PaginatedListClient

Inherited Members

PaginatedResourceClient<List, ListResource, ListCollectionResponse, ListResponse>.PerPage(int)

PaginatedResourceClient<List, ListResource, ListCollectionResponse, ListResponse>.Offset(int)

PaginatedResourceClient<List, ListResource, ListCollectionResponse, ListResponse>.Filter(string)

PaginatedResourceClient<List, ListResource, ListCollectionResponse, ListResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<List, ListResource, ListCollectionResponse, ListResponse>.PostAsync(List, CancellationToken)

PaginatedResourceClient<List, ListResource, ListCollectionResponse, ListResponse>.PostAsync(JsonApiDocument<ListResource>, CancellationToken)

ResourceClient<List>.AddQueryParameter(string, string)

ResourceClient<List>.ReplaceQueryParameter(string, string)

ResourceClient<List>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<List>.Uri

ResourceClient<List>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedListClient(HttpClient, Uri)

Client for interacting with List collection resources.

public PaginatedListClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedListClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedListClient

The current PaginatedListClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedListClient ClearParameters()

Returns

PaginatedListClient

The current PaginatedListClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedListClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedListClient

The current PaginatedListClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of List resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCampus()

Include related Campus resources in the response.

public ListClient IncludeCampus()

Returns

ListClient

IncludeCategory()

Include related Category resources in the response.

public ListClient IncludeCategory()

Returns

ListClient

IncludeCreatedBy()

Include related CreatedBy resources in the response.

public ListClient IncludeCreatedBy()

Returns

ListClient

IncludeMailchimpSyncStatus()

Include related MailchimpSyncStatus resources in the response.

public ListClient IncludeMailchimpSyncStatus()

Returns

ListClient

IncludePeople()

Include related People resources in the response.

public ListClient IncludePeople()

Returns

ListClient

IncludeRules()

Include related Rules resources in the response.

public ListClient IncludeRules()

Returns

ListClient

IncludeShares()

Include related Shares resources in the response.

public ListClient IncludeShares()

Returns

ListClient

IncludeUpdatedBy()

Include related UpdatedBy resources in the response.

public ListClient IncludeUpdatedBy()

Returns

ListClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedListClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedListClient

The current PaginatedListClient instance.

OrderByActiveAutomationsCount()

Sort response items by the ActiveAutomationsCount attribute.

public ListClient OrderByActiveAutomationsCount()

Returns

ListClient

OrderByActiveAutomationsCountDescending()

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

public ListClient OrderByActiveAutomationsCountDescending()

Returns

ListClient

OrderByAutoRefreshFrequency()

Sort response items by the AutoRefreshFrequency attribute.

public ListClient OrderByAutoRefreshFrequency()

Returns

ListClient

OrderByAutoRefreshFrequencyDescending()

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

public ListClient OrderByAutoRefreshFrequencyDescending()

Returns

ListClient

OrderByAutomationsCount()

Sort response items by the AutomationsCount attribute.

public ListClient OrderByAutomationsCount()

Returns

ListClient

OrderByAutomationsCountDescending()

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

public ListClient OrderByAutomationsCountDescending()

Returns

ListClient

OrderByBatchCompletedAt()

Sort response items by the BatchCompletedAt attribute.

public ListClient OrderByBatchCompletedAt()

Returns

ListClient

OrderByBatchCompletedAtDescending()

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

public ListClient OrderByBatchCompletedAtDescending()

Returns

ListClient

OrderByCampusId()

Sort response items by the CampusId attribute.

public ListClient OrderByCampusId()

Returns

ListClient

OrderByCampusIdDescending()

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

public ListClient OrderByCampusIdDescending()

Returns

ListClient

OrderByCampusesName()

Sort response items by the Campuses.Name attribute.

public ListClient OrderByCampusesName()

Returns

ListClient

OrderByCampusesNameDescending()

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

public ListClient OrderByCampusesNameDescending()

Returns

ListClient

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public ListClient OrderByCreatedAt()

Returns

ListClient

OrderByCreatedAtDescending()

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

public ListClient OrderByCreatedAtDescending()

Returns

ListClient

OrderByListCategoriesName()

Sort response items by the ListCategories.Name attribute.

public ListClient OrderByListCategoriesName()

Returns

ListClient

OrderByListCategoriesNameDescending()

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

public ListClient OrderByListCategoriesNameDescending()

Returns

ListClient

OrderByListCategoryId()

Sort response items by the ListCategoryId attribute.

public ListClient OrderByListCategoryId()

Returns

ListClient

OrderByListCategoryIdDescending()

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

public ListClient OrderByListCategoryIdDescending()

Returns

ListClient

OrderByName()

Sort response items by the Name attribute.

public ListClient OrderByName()

Returns

ListClient

OrderByNameDescending()

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

public ListClient OrderByNameDescending()

Returns

ListClient

OrderByNameOrDescription()

Sort response items by the NameOrDescription attribute.

public ListClient OrderByNameOrDescription()

Returns

ListClient

OrderByNameOrDescriptionDescending()

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

public ListClient OrderByNameOrDescriptionDescending()

Returns

ListClient

OrderByRefreshedAt()

Sort response items by the RefreshedAt attribute.

public ListClient OrderByRefreshedAt()

Returns

ListClient

OrderByRefreshedAtDescending()

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

public ListClient OrderByRefreshedAtDescending()

Returns

ListClient

OrderByStarred()

Sort response items by the Starred attribute.

public ListClient OrderByStarred()

Returns

ListClient

OrderByStarredDescending()

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

public ListClient OrderByStarredDescending()

Returns

ListClient

OrderByTotalPeople()

Sort response items by the TotalPeople attribute.

public ListClient OrderByTotalPeople()

Returns

ListClient

OrderByTotalPeopleDescending()

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

public ListClient OrderByTotalPeopleDescending()

Returns

ListClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public ListClient OrderByUpdatedAt()

Returns

ListClient

OrderByUpdatedAtDescending()

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

public ListClient OrderByUpdatedAtDescending()

Returns

ListClient

PerPage(int)

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

public PaginatedListClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedListClient

The current PaginatedListClient instance.

WhereBatchCompletedAt(DateTime)

Query response items by the BatchCompletedAt attribute.

public ListClient WhereBatchCompletedAt(DateTime value)

Parameters

value DateTime

Returns

ListClient

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public ListClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

ListClient

WhereId(string)

Query response items by the Id attribute.

public ListClient WhereId(string value)

Parameters

value string

Returns

ListClient

WhereName(string)

Query response items by the Name attribute.

public ListClient WhereName(string value)

Parameters

value string

Returns

ListClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public ListClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

ListClient

WithId(string)

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

public ListClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ListClient

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