ISessionServiceTerminateSession Method |
Logs off the session with the specified ID.
Namespace:
Dundas.BI.AccountServices
Assembly:
Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.3.0.1000)
Syntax bool TerminateSession(
Guid sessionId
)
Function TerminateSession (
sessionId As Guid
) As Boolean
bool TerminateSession(
Guid sessionId
)
abstract TerminateSession :
sessionId : Guid -> bool
Parameters
- sessionId
- Type: SystemGuid
The ID of the session to terminate.
Return Value
Type:
Boolean if a session with the specified ID was not found; otherwise,
.
Exceptions Exception | Condition |
---|
ArgumentException | sessionId is Empty. |
NoPrivilegeException | The specified session is not associated with the caller. -or- The caller does not have system administration privileges. -or- The specified session is associated with a tenant, but the caller does not have administration privileges for that tenant. |
InvalidSessionException | The caller context is not associated with a valid session. |
Remarks
This method terminates sessions with a reason code of
LoggedOffByAdmin. For that reason,
if a user is logging itself out (and not being logged out by an administrator),
TerminateCurrentSession should be
used instead.
See Also