Class TagGroupClient

Namespace

Crews.PlanningCenter.Api.Calendar.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>.AddCustomParameter(string, string)

ResourceClient<TagGroup>.ClearParameters()

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

Events

Associated Events.

public PaginatedEventClient Events { get; }

Property Value

PaginatedEventClient

Tags

Associated Tags.

public PaginatedTagClient Tags { get; }

Property Value

PaginatedTagClient

Methods

DeleteAsync(CancellationToken)

Deletes the TagGroup resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

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.

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

PatchAsync(TagGroup, CancellationToken)

Updates an existing TagGroup resource asynchronously.

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

Parameters

resource TagGroup

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TagGroupResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<TagGroupResource>, CancellationToken)

Updates an existing TagGroup resource asynchronously.

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

Parameters

document JsonApiDocument<TagGroupResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TagGroupResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.