Class PaginatedListCategoryClient

Namespace

Crews.PlanningCenter.Api.People.V2020_04_06

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ListCategory collection resources.

public class PaginatedListCategoryClient : PaginatedResourceClient<ListCategory, ListCategoryResource, ListCategoryCollectionResponse, ListCategoryResponse>

Inheritance

object

ResourceClient<ListCategory>

PaginatedResourceClient<ListCategory, ListCategoryResource, ListCategoryCollectionResponse, ListCategoryResponse>

PaginatedListCategoryClient

Inherited Members

PaginatedResourceClient<ListCategory, ListCategoryResource, ListCategoryCollectionResponse, ListCategoryResponse>.PerPage(int)

PaginatedResourceClient<ListCategory, ListCategoryResource, ListCategoryCollectionResponse, ListCategoryResponse>.Offset(int)

PaginatedResourceClient<ListCategory, ListCategoryResource, ListCategoryCollectionResponse, ListCategoryResponse>.Filter(string)

PaginatedResourceClient<ListCategory, ListCategoryResource, ListCategoryCollectionResponse, ListCategoryResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ListCategory, ListCategoryResource, ListCategoryCollectionResponse, ListCategoryResponse>.PostAsync(ListCategory, CancellationToken)

PaginatedResourceClient<ListCategory, ListCategoryResource, ListCategoryCollectionResponse, ListCategoryResponse>.PostAsync(JsonApiDocument<ListCategoryResource>, CancellationToken)

ResourceClient<ListCategory>.AddQueryParameter(string, string)

ResourceClient<ListCategory>.ReplaceQueryParameter(string, string)

ResourceClient<ListCategory>.AddCustomParameter(string, string)

ResourceClient<ListCategory>.ClearParameters()

ResourceClient<ListCategory>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ListCategory>.Uri

ResourceClient<ListCategory>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedListCategoryClient(HttpClient, Uri)

Client for interacting with ListCategory collection resources.

public PaginatedListCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of ListCategory resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListCategoryCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeLists()

Include related Lists resources in the response.

public ListCategoryClient IncludeLists()

Returns

ListCategoryClient

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public ListCategoryClient OrderByCreatedAt()

Returns

ListCategoryClient

OrderByCreatedAtDescending()

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

public ListCategoryClient OrderByCreatedAtDescending()

Returns

ListCategoryClient

OrderByName()

Sort response items by the Name attribute.

public ListCategoryClient OrderByName()

Returns

ListCategoryClient

OrderByNameDescending()

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

public ListCategoryClient OrderByNameDescending()

Returns

ListCategoryClient

OrderByOrganizationId()

Sort response items by the OrganizationId attribute.

public ListCategoryClient OrderByOrganizationId()

Returns

ListCategoryClient

OrderByOrganizationIdDescending()

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

public ListCategoryClient OrderByOrganizationIdDescending()

Returns

ListCategoryClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public ListCategoryClient OrderByUpdatedAt()

Returns

ListCategoryClient

OrderByUpdatedAtDescending()

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

public ListCategoryClient OrderByUpdatedAtDescending()

Returns

ListCategoryClient

PostAsync(ListCategory, CancellationToken)

Creates a new ListCategory resource asynchronously.

public Task<ListCategoryResponse> PostAsync(ListCategory resource, CancellationToken cancellationToken = default)

Parameters

resource ListCategory

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<ListCategoryResource>, CancellationToken)

Creates a new ListCategory resource asynchronously.

public Task<ListCategoryResponse> PostAsync(JsonApiDocument<ListCategoryResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ListCategoryResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public ListCategoryClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

ListCategoryClient

WhereName(string)

Query response items by the Name attribute.

public ListCategoryClient WhereName(string value)

Parameters

value string

Returns

ListCategoryClient

WhereOrganizationId(string)

Query response items by the OrganizationId attribute.

public ListCategoryClient WhereOrganizationId(string value)

Parameters

value string

Returns

ListCategoryClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public ListCategoryClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

ListCategoryClient

WithId(string)

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

public ListCategoryClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ListCategoryClient

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