Holds the information about the currently authenticated user.
Inheritance Hierarchy
Spotfire.Dxp.Framework.ApplicationModelUserContext
Namespace: Spotfire.Dxp.Framework.ApplicationModel
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
public sealed class UserContext
The UserContext type exposes the following members.
Properties
Name | Description | |
---|---|---|
DisplayName | Gets the display name of the user. | |
Domain | Gets the domain the user belongs to.
This can be an actual LDAP domain or an internal Spotfire domain. | |
Groups | Gets the names of the groups the user belongs to. | |
IsAuthenticated | Gets a value indicating whether the user is authenticated.
When working offline in the client or when Spotfire Desktop is used, this will be false. | |
Username | Gets the username of the user.
This can have the domain name included or contain only the user name. |
Methods
Name | Description | |
---|---|---|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IsInRole | Determines whether the user has the specific role. | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks
When a user works offline in the client, this class will contain the cached information from the previous session. In that case IsAuthenticated will be false.
In Spotfire Desktop client, i.e. no connection to a server, this class will contain the username of the current Windows account taken from UserName. In that case IsAuthenticated will be false.
Version Information
Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also