Class PaginatedListClient

Namespace

Crews.PlanningCenter.Api.People.V2021_08_17

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>.AddCustomParameter(string, string)

ResourceClient<List>.ClearParameters()

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

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

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

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

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

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.