Class TagClient

Namespace

Crews.PlanningCenter.Api.Calendar.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>.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

TagClient(HttpClient, Uri)

Client for interacting with the Tag resource.

public TagClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

EventInstances

Associated EventInstances.

public PaginatedEventInstanceClient EventInstances { get; }

Property Value

PaginatedEventInstanceClient

Events

Associated Events.

public PaginatedEventClient Events { get; }

Property Value

PaginatedEventClient

TagGroup

Associated TagGroup.

public TagGroupClient TagGroup { get; }

Property Value

TagGroupClient

Methods

DeleteAsync(CancellationToken)

Deletes the Tag 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 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.

IncludeEventInstances()

Include related EventInstances resources in the response.

public TagClient IncludeEventInstances()

Returns

TagClient

IncludeEvents()

Include related Events resources in the response.

public TagClient IncludeEvents()

Returns

TagClient

IncludeTagGroup()

Include related TagGroup resources in the response.

public TagClient IncludeTagGroup()

Returns

TagClient

PatchAsync(Tag, CancellationToken)

Updates an existing Tag resource asynchronously.

public Task<TagResponse> PatchAsync(Tag resource, CancellationToken cancellationToken = default)

Parameters

resource Tag

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TagResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<TagResource>, CancellationToken)

Updates an existing Tag resource asynchronously.

public Task<TagResponse> PatchAsync(JsonApiDocument<TagResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<TagResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TagResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.