Class TagGroupClient
- Namespace
- Crews.PlanningCenter.Api.Groups.V2023_07_10
- Assembly
- Crews.PlanningCenter.Api.dll
Client for interacting with the TagGroup resource.
public class TagGroupClient : SingletonResourceClient<TagGroup, TagGroupResource, TagGroupResponse>- Inheritance
-
TagGroupClient
- Inherited Members
Constructors
TagGroupClient(HttpClient, Uri)
Client for interacting with the TagGroup resource.
public TagGroupClient(HttpClient httpClient, Uri uri)Parameters
httpClientHttpClienturiUri
Properties
Tags
Associated Tags.
public PaginatedTagClient Tags { get; }Property Value
Methods
AddCustomParameter(string, string)
Adds a custom query parameter to the request URI.
public TagGroupClient AddCustomParameter(string parameter, string value)Parameters
Returns
- TagGroupClient
The current TagGroupClient instance.
ClearParameters()
Removes the entire query string from the request URI.
public TagGroupClient ClearParameters()Returns
- TagGroupClient
The current TagGroupClient instance.
GetAsync(CancellationToken)
Fetches the TagGroup resource asynchronously.
public Task<TagGroupResponse> GetAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA token to monitor for cancellation requests.
Returns
- Task<TagGroupResponse>
A task representing the asynchronous operation, containing the TagGroup resource.
Exceptions
- JsonApiException
Thrown when the HTTP response indicates a failure status code.