SessionManager
Class
The SessionManager is used to manage user sign in sessions.
Methods
clearSessions
clearSessions(): voidClear all sessions
Returns
voidgetMainSession
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
UserSessiongetSessions
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): 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
Returns
Promise<UserSession>signOut
signOut(): voidSign out from main portal.
Returns
void