Login(Guid,LoginOptions) Method

Used to login to an Entity Server based on a previously established session key.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function Login( _
   ByVal sessionKey As Guid, _
   Optional ByVal options As LoginOptions _
) As IAuthenticationContext

'Usage
 
Dim instance As Authenticator
Dim sessionKey As Guid
Dim options As LoginOptions
Dim value As IAuthenticationContext
 
value = instance.Login(sessionKey, options)

public IAuthenticationContext Login( 
   Guid sessionKey,
   LoginOptions options
)

Parameters

sessionKey: Uniquely identifies an existing session
options: Characterists of the Entity Server to log into.

Exceptions

Exception	Description
IdeaBlade.EntityModel.LoginException	Invalid session key

Remarks

Use the AuthenticationContext.SessionKey returned from a user session established previously. This login is most useful in ASP.NET applications where an EntityManager is constructed only for the lifetime of a request. Using an existing AuthenticationContext.SessionKey allows you to recreate the user session from a lightweight token.

User sessions will by default timeout after 30 minutes of inactivity. You will receive a IdeaBlade.EntityModel.LoginException if the session has timed out and you attempt to login with the session key. The timeout value can be modified via the UserSessionTimeout setting.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

Authenticator Class
Authenticator Members
Overload List