ISession MembersNFX Class Library

[This is preliminary documentation and is subject to change.]

The ISession type exposes the following members.
Methods

  NameDescription
Public methodAcquire
Acquires session for use
Public methodEnd
Requests container that hosts.runs this entity to end its instance
(Inherited from IEndableInstance.)
Public methodHasJustLoggedIn
Sets IsJustLoggedIn to true to indicate that user has supplied credentials/got checked via security manager. The caller of this method is implementation-specific and depends on what is considered to be "proof of users' identity"
Public methodRegenerateID
Generates new GUID and stores it in ID storing old ID value in OldID property which is not serializable. The implementations may elect to re-stow the existing session under the new ID. This method is usefull for security, i.e. when user logs-in we may want to re-generate ID
Public methodRelease
Releases session after use
Back to Top
Properties

  NameDescription
Public propertyID
Gets unique session identifier
Public propertyIsEnded
Indicates whether this instance was requested to be ended and will get destoyed by the hosting container
(Inherited from IEndableInstance.)
Public propertyIsJustLoggedIn
Indicates that user login happened in current request processing cycle. This flag is useful for long term token assignment on release
Public propertyIsNew
Indicates that session object was just created with current request processing cycle
Public propertyItem
Shortcut to this.Items.TryGetValue(...). Returns null if key is not found
Public propertyItems
References item dictionary that may be used to persist object graphs per session
Public propertyLanguageISOCode
Returns user's language preference or null
Public propertyLastLoginType
Returns last login type
Public propertyLastLoginUTC
Returns the UTC DateTime of the last login/when HasJustLoggedIn() was called for the last time within the lifetime of this session object or NULL
Public propertyOldID
When this parameter is not null then RegenerateID() was called and session provider may need to re-stow session object under a new ID
Public propertyUser
References a user this session is for
Back to Top
See Also