SessionManager
Class
The SessionManager is used to manage user sign in sessions.
Methods
clearSessions
clearSessions(): voidClear all sessions
Returns
voidgenerateSeverSessionByPortalSession
generateSeverSessionByPortalSession(portalSession: UserSession, serverUrl: string, credentialsParamForGenerateToken: string): Promise<UserSession>Generate server session with owning system portal session.
Parameters
- portalSession: UserSession
- serverUrl: string
- credentialsParamForGenerateToken: string = 'same-origin'
Returns
Promise<UserSession>generateToken
generateToken(portalUrl: string, getTokenParam: string, credentialsParam: string): Promise<any>Generate token.
Parameters
- portalUrl: string
- getTokenParam: string = ''
- credentialsParam: string
Returns
Promise<any>getClientIdByUrl
getClientIdByUrl(portalUrl: string): stringGet a valid client id for portal url
Parameters
- portalUrl: string
Returns
stringgetMainSession
getMainSession(): UserSessionReturn main session.
The main session is session of the portal that the app connects to.
Returns
UserSessiongetSessionByUrl
getSessionByUrl(url: string): UserSessionReturn session by url.
Parameters
- url: string
Returns
UserSessiongetSessionKeyFromSession
getSessionKeyFromSession(session: UserSession): stringGet session key from a session.
Parameters
- session: UserSession
Returns
stringgetSessions
getSessions(): UserSession[]Return all sessions.
Returns
UserSession[]handleAuthError
handleAuthError(error: any, popup: boolean): Promise<UserSession>When you need to handle the error caused by sign in, you can catch the error and call this method. This method will try to sign in to get a new session.
Parameters
- error: any
- popup: boolean = true
Returns
Promise<UserSession>removeSession
removeSession(session: UserSession): booleanRemove the session from session manager.
Parameters
- session: UserSession
Returns
booleansignIn
signIn(fromUrl: string, popup: boolean, desUrl: string, clientId?: string): Promise<UserSession>Start OAuth sign in flow and return the user session.
Parameters
- fromUrl: string = '/'
The page you start sign in
- popup: boolean = true
If 'true', the window will popup, or, it will redirect to sign in page
- desUrl: string = ...
The url you want to sign in
- clientId: stringoptional
Returns
Promise<UserSession>signOut
signOut(): voidSign out from main portal.
Returns
voiduseDialogToSetClientIdToConnectiosOfAppConfigAndSignIn
useDialogToSetClientIdToConnectiosOfAppConfigAndSignIn(portalUrl: string, needToSignIn?: boolean, serviceUrl?: string): Promise<any>Popup a dialog to set client id to app config
Parameters
- portalUrl: string
portal url
- needToSignIn: booleanoptional
indicates whether need to sign-in
- serviceUrl: stringoptional
service url
Returns
Promise<any>