Interface IServerSessionProvider

Interface for a class representing the current session details for a signed-in user.

Namespace: Tableau.Migration.Api

Assembly: Tableau.Migration.dll

Syntax

public interface IServerSessionProvider

Properties

InstanceType

The type of Tableau instance connected to. One of the values in InstanceType.

Declaration

TableauInstanceType InstanceType { get; }

Property Value

Type	Description
TableauInstanceType

SiteContentUrl

Gets the current site's content URL.

Declaration

string? SiteContentUrl { get; }

Property Value

Type	Description
string

SiteId

Gets the current site's ID.

Declaration

Guid? SiteId { get; }

Property Value

Type	Description
Guid?

UserId

Gets the current user's ID.

Declaration

Guid? UserId { get; }

Property Value

Type	Description
Guid?

Version

Gets the server's version information.

Declaration

TableauServerVersion? Version { get; }

Property Value

Type	Description
TableauServerVersion?

Methods

ClearCurrentSessionAsync(CancellationToken)

Clears the current session information.

Declaration

Task ClearCurrentSessionAsync(CancellationToken cancel)

Parameters

Type	Name	Description
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task	The task to await.

SetCurrentSessionAsync(Guid, Guid, string, string, TableauInstanceType, CancellationToken)

Sets the current session information.

Declaration

Task SetCurrentSessionAsync(Guid userId, Guid siteId, string siteContentUrl, string authenticationToken, TableauInstanceType instanceType, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	userId	The current user's ID.
Guid	siteId	The current site's ID.
string	siteContentUrl	The current site's content URL.
string	authenticationToken	The current user's authentication token.
TableauInstanceType	instanceType	The instance type connected to. It can be one of TableauInstanceType.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task	The task to await.

SetCurrentSessionAsync(ISignInResult, TableauInstanceType, CancellationToken)

Sets the current session information.

Declaration

Task SetCurrentSessionAsync(ISignInResult signInResult, TableauInstanceType instanceType, CancellationToken cancel)

Parameters

Type	Name	Description
ISignInResult	signInResult	The sign-in result containing the current user and site information.
TableauInstanceType	instanceType	The instance type connected to. It can be one of TableauInstanceType.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task	The task to await.

SetVersion(TableauServerVersion)

Sets the current version information.

Declaration

void SetVersion(TableauServerVersion version)

Parameters

Type	Name	Description
TableauServerVersion	version	The server's version information.