Interface IApiClient
Interface for unauthenticated API clients.
Namespace: Tableau.Migration.Api
Assembly: Tableau.Migration.dll
Syntax
public interface IApiClientMethods
GetCurrentServerSessionAsync(CancellationToken)
Gets the current session information.
Declaration
Task<IResult<IServerSession>> GetCurrentServerSessionAsync(CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IResult<IServerSession>> | The session information. |
GetServerInfoAsync(CancellationToken)
Gets the version information for the Tableau Server.
Declaration
Task<IResult<IServerInfo>> GetServerInfoAsync(CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IResult<IServerInfo>> | The information for the current Tableau Server. |
SignInAsync(CancellationToken)
Signs into Tableau Server.
Declaration
Task<IAsyncDisposableResult<ISitesApiClient>> SignInAsync(CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IAsyncDisposableResult<ISitesApiClient>> | An authenticated ISitesApiClient. |