Interface IFavoritesContentClient
Interface for a client that can interact with favorites.
Namespace: Tableau.Migration.Engine.Endpoints.ContentClients
Assembly: Tableau.Migration.dll
Syntax
public interface IFavoritesContentClient : IContentClient<IFavorite>Methods
DeleteFavoriteForUserIdAsync(Guid, IFavorite, CancellationToken)
Delete favorite for a user
Declaration
Task<IResult> DeleteFavoriteForUserIdAsync(Guid userId, IFavorite favorite, CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | userId | UserId of the user. |
| IFavorite | favorite | The favorite item to delete. |
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IResult> | Result of the operation. |
GetAllByUserAsync(IContentReference, CancellationToken)
Get all favorites for a user by the content reference
Declaration
Task<IResult<IImmutableList<IFavorite>>> GetAllByUserAsync(IContentReference user, CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| IContentReference | user | The IContentReference of the user. |
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IResult<IImmutableList<IFavorite>>> | List of all favorites of a user. |