[This is preliminary documentation and is subject to change.]
The ISession type exposes the following members.Methods
Name | Description | |
---|---|---|
![]() | Acquire |
Acquires session for use
|
![]() | End |
Requests container that hosts.runs this entity to end its instance
(Inherited from IEndableInstance.) |
![]() | HasJustLoggedIn |
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"
|
![]() | RegenerateID |
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
|
![]() | Release |
Releases session after use
|
Properties
Name | Description | |
---|---|---|
![]() | ID |
Gets unique session identifier
|
![]() | IsEnded |
Indicates whether this instance was requested to be ended and will get destoyed by the hosting container
(Inherited from IEndableInstance.) |
![]() | IsJustLoggedIn |
Indicates that user login happened in current request processing cycle. This flag is
useful for long term token assignment on release
|
![]() | IsNew |
Indicates that session object was just created with current request processing cycle
|
![]() | Item |
Shortcut to this.Items.TryGetValue(...). Returns null if key is not found
|
![]() | Items |
References item dictionary that may be used to persist object graphs per session
|
![]() | LanguageISOCode |
Returns user's language preference or null
|
![]() | LastLoginType |
Returns last login type
|
![]() | LastLoginUTC |
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
|
![]() | OldID |
When this parameter is not null then RegenerateID() was called and session provider may need to re-stow session object under a new ID
|
![]() | User |
References a user this session is for
|
See Also