Class TagClient

Namespace

Crews.PlanningCenter.Api.Groups.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Tag resource.

public class TagClient : SingletonResourceClient<Tag, TagResource, TagResponse>

Inheritance

object

ResourceClient<Tag>

SingletonResourceClient<Tag, TagResource, TagResponse>

TagClient

Inherited Members

SingletonResourceClient<Tag, TagResource, TagResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Tag, TagResource, TagResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Tag, TagResource, TagResponse>.PatchAsync(Tag, CancellationToken)

SingletonResourceClient<Tag, TagResource, TagResponse>.PatchAsync(JsonApiDocument<TagResource>, CancellationToken)

SingletonResourceClient<Tag, TagResource, TagResponse>.DeleteAsync(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

TagClient(HttpClient, Uri)

Client for interacting with the Tag resource.

public TagClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Groups

Associated Groups.

public PaginatedGroupClient Groups { get; }

Property Value

PaginatedGroupClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public TagClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

TagClient

The current TagClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public TagClient ClearParameters()

Returns

TagClient

The current TagClient instance.

GetAsync(CancellationToken)

Fetches the Tag resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TagResponse>

A task representing the asynchronous operation, containing the Tag resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.