Interface ITagsApiClient
Interface for an API client that modifies content's tags.
Namespace: Tableau.Migration.Api.Tags
Assembly: Tableau.Migration.dll
Syntax
public interface ITagsApiClientMethods
AddTagsAsync(Guid, IEnumerable<ITag>, CancellationToken)
Adds tags to the content item.
Declaration
Task<IResult<IImmutableList<ITag>>> AddTagsAsync(Guid contentItemId, IEnumerable<ITag> tags, CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | contentItemId | The ID of the content item. |
| IEnumerable<ITag> | tags | The tags to add. |
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IResult<IImmutableList<ITag>>> | All tags on content item. |
RemoveTagsAsync(Guid, IEnumerable<ITag>, CancellationToken)
Remove tags from the content item.
Declaration
Task<IResult> RemoveTagsAsync(Guid contentItemId, IEnumerable<ITag> tags, CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | contentItemId | The ID of the content item. |
| IEnumerable<ITag> | tags | The tags to remove. |
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IResult> |
UpdateTagsAsync(Guid, IEnumerable<ITag>, CancellationToken)
Adds and removes tags from the content item to match the new tags.
Declaration
Task<IResult> UpdateTagsAsync(Guid contentItemId, IEnumerable<ITag> tags, CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | contentItemId | The ID of the content ite. |
| IEnumerable<ITag> | tags | The tags to update to match. |
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IResult> |