ISessionManager
Overview
The ISessionManager interface provides abstract interface for concrete session manager implementations.
Location
- Reference: RemObjects.SDK.Server.dll
- Namespace: RemObjects.SDK.Server
- Platforms: .NET Core, .NET Framework, .NET Standard
DestroySession
Destroys session with provided Id.
method DestroySession(sessionId: Guid)
void DestroySession(Guid sessionId)
func DestroySession(_ sessionId: Guid)
Sub DestroySession(sessionId As Guid)
Parameters:
- sessionId: Session Id
GetAllSessions
Returns identifiers of all non-expired sessions stored in thesession manager.
method GetAllSessions: IList<Guid>
IList<Guid> GetAllSessions()
func GetAllSessions() -> IList<Guid>
Function GetAllSessions() As IList<Guid>
GetExistingSession
Returns existing session with provided Id or null in case the session cannot be found. Depending on the updateTime parameter value updates the session's LastaccessedTime attribute.
method GetExistingSession(sessionId: Guid; updateTime: Boolean): ISession
ISession GetExistingSession(Guid sessionId, Boolean updateTime)
func GetExistingSession(_ sessionId: Guid, _ updateTime: Boolean) -> ISession
Function GetExistingSession(sessionId As Guid, updateTime As Boolean) As ISession
Parameters:
- sessionId: Session Id
- updateTime: Flag indicating whether session's LastAccessedTime attribute should be updated
GetSession
Returns session with provided Id. If there is no session stored with the provided Id then new session is created.
method GetSession(sessionId: Guid): ISession
ISession GetSession(Guid sessionId)
func GetSession(_ sessionId: Guid) -> ISession
Function GetSession(sessionId As Guid) As ISession
Parameters:
- sessionId: Session Id
IsOutOfProcess
Gets a flag indicating that session manager uses out-of-process session storage.
It is strongly recommended to avoid storing complex objects in user sessions in case this property returns true.
property IsOutOfProcess: Boolean read;
Boolean IsOutOfProcess { get; }
var IsOutOfProcess: Boolean { get{} }
ReadOnly Property IsOutOfProcess() As Boolean
ReleaseSession
Releases session back into the session storage.
method ReleaseSession(session: ISession)
void ReleaseSession(ISession session)
func ReleaseSession(_ session: ISession)
Sub ReleaseSession(session As ISession)
Parameters:
- session: Session instance
IsOutOfProcess
Gets a flag indicating that session manager uses out-of-process session storage.
It is strongly recommended to avoid storing complex objects in user sessions in case this property returns true.
property IsOutOfProcess: Boolean read;
Boolean IsOutOfProcess { get; }
var IsOutOfProcess: Boolean { get{} }
ReadOnly Property IsOutOfProcess() As Boolean
DestroySession
Destroys session with provided Id.
method DestroySession(sessionId: Guid)
void DestroySession(Guid sessionId)
func DestroySession(_ sessionId: Guid)
Sub DestroySession(sessionId As Guid)
Parameters:
- sessionId: Session Id
GetAllSessions
Returns identifiers of all non-expired sessions stored in thesession manager.
method GetAllSessions: IList<Guid>
IList<Guid> GetAllSessions()
func GetAllSessions() -> IList<Guid>
Function GetAllSessions() As IList<Guid>
GetExistingSession
Returns existing session with provided Id or null in case the session cannot be found. Depending on the updateTime parameter value updates the session's LastaccessedTime attribute.
method GetExistingSession(sessionId: Guid; updateTime: Boolean): ISession
ISession GetExistingSession(Guid sessionId, Boolean updateTime)
func GetExistingSession(_ sessionId: Guid, _ updateTime: Boolean) -> ISession
Function GetExistingSession(sessionId As Guid, updateTime As Boolean) As ISession
Parameters:
- sessionId: Session Id
- updateTime: Flag indicating whether session's LastAccessedTime attribute should be updated
GetSession
Returns session with provided Id. If there is no session stored with the provided Id then new session is created.
method GetSession(sessionId: Guid): ISession
ISession GetSession(Guid sessionId)
func GetSession(_ sessionId: Guid) -> ISession
Function GetSession(sessionId As Guid) As ISession
Parameters:
- sessionId: Session Id
ReleaseSession
Releases session back into the session storage.
method ReleaseSession(session: ISession)
void ReleaseSession(ISession session)
func ReleaseSession(_ session: ISession)
Sub ReleaseSession(session As ISession)
Parameters:
- session: Session instance