Interface ICustomViewsApiClient

Interface for API client Custom View operations.

Inherited Members

IPagedListApiClient<ICustomView>.GetPager(int)

IPagedListApiClient<ICustomView>.GetAllAsync(int, CancellationToken)

IApiPageAccessor<ICustomView>.GetPageAsync(int, int, CancellationToken)

IContentApiClient.UrlPrefix

IReadApiClient<ICustomView>.GetByIdAsync(Guid, CancellationToken)

IPullApiClient<ICustomView, IPublishableCustomView>.PullAsync(ICustomView, CancellationToken)

IPublishApiClient<IPublishableCustomView, ICustomView>.PublishAsync(IPublishableCustomView, CancellationToken)

Namespace: Tableau.Migration.Api

Assembly: Tableau.Migration.dll

Syntax

public interface ICustomViewsApiClient : IPagedListApiClient<ICustomView>, IApiPageAccessor<ICustomView>, IContentApiClient, IReadApiClient<ICustomView>, IPullApiClient<ICustomView, IPublishableCustomView>, IPublishApiClient<IPublishableCustomView, ICustomView>

Methods

DeleteCustomViewAsync(Guid, CancellationToken)

Deletes the specified custom view.

Declaration

Task<IResult> DeleteCustomViewAsync(Guid id, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	id	The ID for the custom view.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult>

DownloadCustomViewAsync(Guid, CancellationToken)

Downloads the custom view.

Declaration

Task<IAsyncDisposableResult<FileDownload>> DownloadCustomViewAsync(Guid customViewId, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	customViewId	The ID for the custom view.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IAsyncDisposableResult<FileDownload>>

GetAllCustomViewDefaultUsersAsync(Guid, CancellationToken)

Gets the list of user content references whose default view is the specified custom view.

Declaration

Task<IResult<IImmutableList<IContentReference>>> GetAllCustomViewDefaultUsersAsync(Guid id, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	id	The ID for the custom view.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<IImmutableList<IContentReference>>>	A list of all users whose default view is the specified custom view.

GetAllCustomViewsAsync(int, int, CancellationToken)

Gets all custom views in the current site.

Declaration

Task<IPagedResult<ICustomView>> GetAllCustomViewsAsync(int pageNumber, int pageSize, CancellationToken cancel)

Parameters

Type	Name	Description
int	pageNumber	The 1-indexed page number.
int	pageSize	The size of the page.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IPagedResult<ICustomView>>	A list of a page of custom views in the current site.

GetCustomViewDefaultUsersAsync(Guid, int, int, CancellationToken)

Gets the paged list of user content references whose default view is the specified custom view.

Declaration

Task<IPagedResult<IContentReference>> GetCustomViewDefaultUsersAsync(Guid id, int pageNumber, int pageSize, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	id	The ID for the custom view.
int	pageNumber	The 1-indexed page number.
int	pageSize	The size of the page.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IPagedResult<IContentReference>>	A list of a page of users whose default view is the specified custom view.

SetCustomViewDefaultUsersAsync(Guid, IEnumerable<IContentReference>, CancellationToken)

Sets the specified custom for as the default view for up to 100 specified users. Success or failure for each user is reported in the response body.

Declaration

Task<IResult<IImmutableList<ICustomViewAsUserDefaultViewResult>>> SetCustomViewDefaultUsersAsync(Guid id, IEnumerable<IContentReference> users, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	id	The ID for the custom view.
IEnumerable<IContentReference>	users	The list of users.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<IImmutableList<ICustomViewAsUserDefaultViewResult>>>

UpdateCustomViewAsync(Guid, CancellationToken, Guid?, string?)

Changes the owner of an existing custom view.

Declaration

Task<IResult<ICustomView>> UpdateCustomViewAsync(Guid id, CancellationToken cancel, Guid? newOwnerId = null, string? newViewName = null)

Parameters

Type	Name	Description
Guid	id	The ID for the custom view.
CancellationToken	cancel	The cancellation token to obey.
Guid?	newOwnerId	The new owner ID.
string	newViewName	The new view name.

Returns

Type	Description
Task<IResult<ICustomView>>