IUserManager Interface

The interface for the object that manages lists of users.

Namespace: VirtualRadar.Interface.Settings
Assembly: VirtualRadar.Interface (in VirtualRadar.Interface.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public interface IUserManager : ISingleton<IUserManager>

Public Interface IUserManager
	Inherits ISingleton(Of IUserManager)

public interface class IUserManager : ISingleton<IUserManager^>

type IUserManager =  
    interface
        interface ISingleton<IUserManager>
    end

The IUserManager type exposes the following members.

Properties

	Name	Description
	CanChangeEnabledState	Gets a value indicating that the manager can enable or disable user accounts.
	CanChangePassword	Gets a value indicating that the manager can change passwords on user accounts.
	CanCreateUsers	Gets a value indicating that the manager can create new user accounts.
	CanCreateUsersWithHash	Gets a value indicating that the manager can create a user and make use of a password hash supplied by VRS.
	CanDeleteUsers	Gets a value indicating that the manager can delete user accounts.
	CanEditUsers	Gets a value indicating that the manager can modify user accounts.
	CanListUsers	Gets a value indicating that the manager can retrieve a list of users.
	LoginNameIsCaseSensitive	Gets a value indicating that the login name is case sensitive.
	Name	Gets the name of the manager.
	Singleton	Gets the single instance of the class that should be used throughout the application. (Inherited from ISingletonT.)

Methods

	Name	Description
	CreateUser	Creates a new user. If CanCreateUsers is false then this should throw an exception when called. The user manager is expected to modify the record passed in to set IsPersisted to true and to fill in the unique ID.
	CreateUserWithHash	Creates a new user. If CanCreateUsersWithHash is false then this should throw an exception when called.
	DeleteUser	Delete the user passed across. Throw an exception if the deletion is not permitted, otherwise remove the user from the backing store.
	GenerateTemporaryUniqueId	Returns an identifier that does not exist on any user record, has not been previously returned by other calls to GenerateTemporaryUniqueId in this session and cannot be assigned to a new user by any of the Create calls.
	GetUserByLoginName	Returns the user with the login name specified or null if no such user exists.
	GetUsers	Returns a list of all users. Throw an exception if CanListUsers is false.
	GetUsersByUniqueId	Returns a collection of users that have the unique identifiers passed across.
	Initialise	Initialises the manager.
	PasswordMatches	Returns true if the password is a match for the user's password.
	Shutdown	Shuts the manager down.
	UpdateUser	Edits an existing user. Throw an exception if the change is not permitted, otherwise modify the backing store to reflect the change in details for the user with the appropriate UniqueID.
	ValidateUser	Validates the record passed across.