Class PaginatedTagGroupClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with TagGroup collection resources.

public class PaginatedTagGroupClient : PaginatedResourceClient<TagGroup, TagGroupResource, TagGroupCollectionResponse, TagGroupResponse>

Inheritance

object

ResourceClient<TagGroup>

PaginatedResourceClient<TagGroup, TagGroupResource, TagGroupCollectionResponse, TagGroupResponse>

PaginatedTagGroupClient

Inherited Members

PaginatedResourceClient<TagGroup, TagGroupResource, TagGroupCollectionResponse, TagGroupResponse>.PerPage(int)

PaginatedResourceClient<TagGroup, TagGroupResource, TagGroupCollectionResponse, TagGroupResponse>.Offset(int)

PaginatedResourceClient<TagGroup, TagGroupResource, TagGroupCollectionResponse, TagGroupResponse>.Filter(string)

PaginatedResourceClient<TagGroup, TagGroupResource, TagGroupCollectionResponse, TagGroupResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<TagGroup, TagGroupResource, TagGroupCollectionResponse, TagGroupResponse>.PostAsync(TagGroup, CancellationToken)

PaginatedResourceClient<TagGroup, TagGroupResource, TagGroupCollectionResponse, TagGroupResponse>.PostAsync(JsonApiDocument<TagGroupResource>, CancellationToken)

ResourceClient<TagGroup>.AddQueryParameter(string, string)

ResourceClient<TagGroup>.ReplaceQueryParameter(string, string)

ResourceClient<TagGroup>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<TagGroup>.Uri

ResourceClient<TagGroup>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedTagGroupClient(HttpClient, Uri)

Client for interacting with TagGroup collection resources.

public PaginatedTagGroupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedTagGroupClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedTagGroupClient

The current PaginatedTagGroupClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedTagGroupClient ClearParameters()

Returns

PaginatedTagGroupClient

The current PaginatedTagGroupClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedTagGroupClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedTagGroupClient

The current PaginatedTagGroupClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of TagGroup resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TagGroupCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEvents()

Include related Events resources in the response.

public TagGroupClient IncludeEvents()

Returns

TagGroupClient

IncludeTags()

Include related Tags resources in the response.

public TagGroupClient IncludeTags()

Returns

TagGroupClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedTagGroupClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedTagGroupClient

The current PaginatedTagGroupClient instance.

OrderByName()

Sort response items by the Name attribute.

public TagGroupClient OrderByName()

Returns

TagGroupClient

OrderByNameDescending()

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

public TagGroupClient OrderByNameDescending()

Returns

TagGroupClient

PerPage(int)

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

public PaginatedTagGroupClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedTagGroupClient

The current PaginatedTagGroupClient instance.

PostAsync(TagGroup, CancellationToken)

Creates a new TagGroup resource asynchronously.

public Task<TagGroupResponse> PostAsync(TagGroup resource, CancellationToken cancellationToken = default)

Parameters

resource TagGroup

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TagGroupResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<TagGroupResource>, CancellationToken)

Creates a new TagGroup resource asynchronously.

public Task<TagGroupResponse> PostAsync(JsonApiDocument<TagGroupResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<TagGroupResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TagGroupResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public TagGroupClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

TagGroupClient

WhereName(string)

Query response items by the Name attribute.

public TagGroupClient WhereName(string value)

Parameters

value string

Returns

TagGroupClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public TagGroupClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

TagGroupClient

WithId(string)

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

public TagGroupClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

TagGroupClient

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