UserContext Class

Spotfire 14.3 API Reference
Holds the information about the currently authenticated user.
Inheritance Hierarchy

SystemObject
  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

  NameDescription
Public propertyDisplayName
Gets the display name of the user.
Public propertyDomain
Gets the domain the user belongs to. This can be an actual LDAP domain or an internal Spotfire domain.
Public propertyGroups
Gets the names of the groups the user belongs to.
Public propertyIsAuthenticated
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.
Public propertyUsername
Gets the username of the user. This can have the domain name included or contain only the user name.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsInRole
Determines whether the user has the specific role.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

An instance of this class is always available as a user level service and can be accessed using one of the GetService methods available in the caller context.

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

Reference