Class PaginatedTagClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

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

ResourceClient<Tag>.ClearParameters()

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

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.

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.