Class PaginatedTabClient

Namespace

Crews.PlanningCenter.Api.People.V2020_07_22

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Tab collection resources.

public class PaginatedTabClient : PaginatedResourceClient<Tab, TabResource, TabCollectionResponse, TabResponse>

Inheritance

object

ResourceClient<Tab>

PaginatedResourceClient<Tab, TabResource, TabCollectionResponse, TabResponse>

PaginatedTabClient

Inherited Members

PaginatedResourceClient<Tab, TabResource, TabCollectionResponse, TabResponse>.PerPage(int)

PaginatedResourceClient<Tab, TabResource, TabCollectionResponse, TabResponse>.Offset(int)

PaginatedResourceClient<Tab, TabResource, TabCollectionResponse, TabResponse>.Filter(string)

PaginatedResourceClient<Tab, TabResource, TabCollectionResponse, TabResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Tab, TabResource, TabCollectionResponse, TabResponse>.PostAsync(Tab, CancellationToken)

PaginatedResourceClient<Tab, TabResource, TabCollectionResponse, TabResponse>.PostAsync(JsonApiDocument<TabResource>, CancellationToken)

ResourceClient<Tab>.AddQueryParameter(string, string)

ResourceClient<Tab>.ReplaceQueryParameter(string, string)

ResourceClient<Tab>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Tab>.Uri

ResourceClient<Tab>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedTabClient(HttpClient, Uri)

Client for interacting with Tab collection resources.

public PaginatedTabClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedTabClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedTabClient

The current PaginatedTabClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedTabClient ClearParameters()

Returns

PaginatedTabClient

The current PaginatedTabClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedTabClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedTabClient

The current PaginatedTabClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Tab resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TabCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeFieldDefinitions()

Include related FieldDefinitions resources in the response.

public TabClient IncludeFieldDefinitions()

Returns

TabClient

IncludeFieldOptions()

Include related FieldOptions resources in the response.

public TabClient IncludeFieldOptions()

Returns

TabClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedTabClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedTabClient

The current PaginatedTabClient instance.

OrderByName()

Sort response items by the Name attribute.

public TabClient OrderByName()

Returns

TabClient

OrderByNameDescending()

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

public TabClient OrderByNameDescending()

Returns

TabClient

OrderBySequence()

Sort response items by the Sequence attribute.

public TabClient OrderBySequence()

Returns

TabClient

OrderBySequenceDescending()

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

public TabClient OrderBySequenceDescending()

Returns

TabClient

OrderBySlug()

Sort response items by the Slug attribute.

public TabClient OrderBySlug()

Returns

TabClient

OrderBySlugDescending()

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

public TabClient OrderBySlugDescending()

Returns

TabClient

PerPage(int)

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

public PaginatedTabClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedTabClient

The current PaginatedTabClient instance.

PostAsync(Tab, CancellationToken)

Creates a new Tab resource asynchronously.

public Task<TabResponse> PostAsync(Tab resource, CancellationToken cancellationToken = default)

Parameters

resource Tab

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TabResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<TabResource>, CancellationToken)

Creates a new Tab resource asynchronously.

public Task<TabResponse> PostAsync(JsonApiDocument<TabResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<TabResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TabResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereName(string)

Query response items by the Name attribute.

public TabClient WhereName(string value)

Parameters

value string

Returns

TabClient

WhereSequence(int)

Query response items by the Sequence attribute.

public TabClient WhereSequence(int value)

Parameters

value int

Returns

TabClient

WhereSlug(string)

Query response items by the Slug attribute.

public TabClient WhereSlug(string value)

Parameters

value string

Returns

TabClient

WithId(string)

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

public TabClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

TabClient

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