Class TagGroupClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the TagGroup resource.

public class TagGroupClient : SingletonResourceClient<TagGroup, TagGroupResource, TagGroupResponse>

Inheritance

object

ResourceClient<TagGroup>

SingletonResourceClient<TagGroup, TagGroupResource, TagGroupResponse>

TagGroupClient

Inherited Members

SingletonResourceClient<TagGroup, TagGroupResource, TagGroupResponse>.GetAsync(CancellationToken)

SingletonResourceClient<TagGroup, TagGroupResource, TagGroupResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<TagGroup, TagGroupResource, TagGroupResponse>.PatchAsync(TagGroup, CancellationToken)

SingletonResourceClient<TagGroup, TagGroupResource, TagGroupResponse>.PatchAsync(JsonApiDocument<TagGroupResource>, CancellationToken)

SingletonResourceClient<TagGroup, TagGroupResource, TagGroupResponse>.DeleteAsync(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

TagGroupClient(HttpClient, Uri)

Client for interacting with the TagGroup resource.

public TagGroupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Folder

Associated Folder.

public FolderClient Folder { get; }

Property Value

FolderClient

Tags

Associated Tags.

public PaginatedTagClient Tags { get; }

Property Value

PaginatedTagClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public TagGroupClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

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

cancellationToken CancellationToken

A 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.

IncludeFolder()

Include related Folder resources in the response.

public TagGroupClient IncludeFolder()

Returns

TagGroupClient

IncludeTags()

Include related Tags resources in the response.

public TagGroupClient IncludeTags()

Returns

TagGroupClient