SmartAPI
Open Source .NET RQL library for RedDot CMS / OpenText WSM Management Server
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
erminas.SmartAPI.Utils.SessionBuilder Class Reference

Utility class to create Session objects with given login data/login guid/session key and project guid. Useful for RedDot plugins. More...

Public Member Functions

 SessionBuilder (ServerLogin login, Guid loginGuid, string sessionKey, Guid projectGuid)
 
 SessionBuilder ()
 
ISession CreateSession ()
 Create a new session initialized with the login guid, session key and project guid of this SessionBuilder.
 

Static Public Member Functions

static ISession CreateOrReplaceOldestSession (ServerLogin login)
 
static ISession CreateOrReplaceSession (ServerLogin login, Func< IEnumerable< RunningSessionInfo >, RunningSessionInfo > sessionReplacementSelector)
 
static ISession CreateSession (ServerLogin login)
 

Properties

ServerLogin Login [get, set]
 
Guid LoginGuid [get, set]
 
Guid ProjectGuid [get, set]
 
string SessionKey [get, set]
 

Detailed Description

Utility class to create Session objects with given login data/login guid/session key and project guid. Useful for RedDot plugins.

Definition at line 26 of file SessionBuilder.cs.

Constructor & Destructor Documentation

erminas.SmartAPI.Utils.SessionBuilder.SessionBuilder ( ServerLogin  login,
Guid  loginGuid,
string  sessionKey,
Guid  projectGuid 
)

Definition at line 28 of file SessionBuilder.cs.

erminas.SmartAPI.Utils.SessionBuilder.SessionBuilder ( )

Definition at line 36 of file SessionBuilder.cs.

Member Function Documentation

static ISession erminas.SmartAPI.Utils.SessionBuilder.CreateOrReplaceOldestSession ( ServerLogin  login)
static

Definition at line 40 of file SessionBuilder.cs.

static ISession erminas.SmartAPI.Utils.SessionBuilder.CreateOrReplaceSession ( ServerLogin  login,
Func< IEnumerable< RunningSessionInfo >, RunningSessionInfo sessionReplacementSelector 
)
static

Definition at line 47 of file SessionBuilder.cs.

ISession erminas.SmartAPI.Utils.SessionBuilder.CreateSession ( )

Create a new session initialized with the login guid, session key and project guid of this SessionBuilder.

Returns

Definition at line 58 of file SessionBuilder.cs.

static ISession erminas.SmartAPI.Utils.SessionBuilder.CreateSession ( ServerLogin  login)
static

Definition at line 63 of file SessionBuilder.cs.

Property Documentation

ServerLogin erminas.SmartAPI.Utils.SessionBuilder.Login
getset

Definition at line 68 of file SessionBuilder.cs.

Guid erminas.SmartAPI.Utils.SessionBuilder.LoginGuid
getset

Definition at line 69 of file SessionBuilder.cs.

Guid erminas.SmartAPI.Utils.SessionBuilder.ProjectGuid
getset

Definition at line 70 of file SessionBuilder.cs.

string erminas.SmartAPI.Utils.SessionBuilder.SessionKey
getset

Definition at line 71 of file SessionBuilder.cs.


The documentation for this class was generated from the following file: