Class PaginatedTagClient

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Tag collection resources.

public class PaginatedTagClient : PaginatedResourceClient<Tag, TagResource, TagCollectionResponse, TagResponse>

Inheritance

object

ResourceClient<Tag>

PaginatedResourceClient<Tag, TagResource, TagCollectionResponse, TagResponse>

PaginatedTagClient

Inherited Members

PaginatedResourceClient<Tag, TagResource, TagCollectionResponse, TagResponse>.PerPage(int)

PaginatedResourceClient<Tag, TagResource, TagCollectionResponse, TagResponse>.Offset(int)

PaginatedResourceClient<Tag, TagResource, TagCollectionResponse, TagResponse>.Filter(string)

PaginatedResourceClient<Tag, TagResource, TagCollectionResponse, TagResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Tag, TagResource, TagCollectionResponse, TagResponse>.PostAsync(Tag, CancellationToken)

PaginatedResourceClient<Tag, TagResource, TagCollectionResponse, TagResponse>.PostAsync(JsonApiDocument<TagResource>, CancellationToken)

ResourceClient<Tag>.AddQueryParameter(string, string)

ResourceClient<Tag>.ReplaceQueryParameter(string, string)

ResourceClient<Tag>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Tag>.Uri

ResourceClient<Tag>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedTagClient(HttpClient, Uri)

Client for interacting with Tag collection resources.

public PaginatedTagClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedTagClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedTagClient

The current PaginatedTagClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedTagClient ClearParameters()

Returns

PaginatedTagClient

The current PaginatedTagClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedTagClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedTagClient

The current PaginatedTagClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Tag resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TagCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedTagClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedTagClient

The current PaginatedTagClient instance.

OrderByName()

Sort response items by the Name attribute.

public TagClient OrderByName()

Returns

TagClient

OrderByNameDescending()

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

public TagClient OrderByNameDescending()

Returns

TagClient

OrderByPosition()

Sort response items by the Position attribute.

public TagClient OrderByPosition()

Returns

TagClient

OrderByPositionDescending()

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

public TagClient OrderByPositionDescending()

Returns

TagClient

PerPage(int)

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

public PaginatedTagClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedTagClient

The current PaginatedTagClient instance.

WhereId(string)

Query response items by the Id attribute.

public TagClient WhereId(string value)

Parameters

value string

Returns

TagClient

WhereName(string)

Query response items by the Name attribute.

public TagClient WhereName(string value)

Parameters

value string

Returns

TagClient

WithId(string)

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

public TagClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

TagClient

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