SessionManager
Class
The SessionManager is used to manage user sign in sessions.
Methods
| Method | Returns | Notes |
|---|---|---|
void | Clear all sessions | |
generateSeverSessionByPortalSession(portalSession, serverUrl, credentialsParamForGenerateToken) | Promise<UserSession> | Generate server session with owning system portal session. |
generateToken(portalUrl, getTokenParam, credentialsParam) | Promise<any> | Generate token. |
getClientIdByUrl(portalUrl) | string | Get a valid client id for portal url |
UserSession | Return main session. | |
getSessionByUrl(url) | UserSession | Return session by url. |
getSessionKeyFromSession(session) | string | Get session key from a session. |
UserSession[] | Return all sessions. | |
getSignInErrorByCode(errorCode) | SignInError | Get the sign-in error by providing the sign-in error code. |
SignInErrorCode | Get the sign-in error by providing the authentication error. | |
handleAuthError(error, popup) | 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. |
removeSession(session) | boolean | Remove the session from session manager. |
signIn(fromUrl, popup, desUrl, clientId?, forceLogin?) | Promise<UserSession> | Start OAuth sign in flow and return the user session. |
signOut() | void | Sign out from main portal. |
useDialogToSetClientIdToConnectiosOfAppConfigAndSignIn(portalUrl, needToSignIn?, serviceUrl?) | Promise<any> | Popup a dialog to set client id to app config |
Get singleton instance. |
generateSeverSessionByPortalSession
Class MethodgenerateSeverSessionByPortalSession(portalSession: UserSession, serverUrl: string, credentialsParamForGenerateToken: string): Promise<UserSession>Generate server session with owning system portal session.
Parameters
| Parameter | Type | Default | Notes |
|---|---|---|---|
portal | UserSession | | A session of ArcGIS REST JS 'UserSession' representing a logged in user. |
server | string | | |
credentials | string | 'same-origin' |
Returns
Promise<UserSession>generateToken
Class MethodgenerateToken(portalUrl: string, getTokenParam: string, credentialsParam: string): Promise<any>Generate token.
Parameters
| Parameter | Type | Default | Notes |
|---|---|---|---|
portal | string | | |
get | string | '' | |
credentials | string | |
Returns
Promise<any>getClientIdByUrl
Class MethodgetClientIdByUrl(portalUrl: string): stringGet a valid client id for portal url
Parameters
| Parameter | Type |
|---|---|
portal | string |
Returns
stringgetMainSession
Class MethodgetMainSession(): UserSessionReturn main session.
The main session is session of the portal that the app connects to.
Returns
UserSession(https://esri.github.io/arcgis-rest-js/api/auth/UserSession) representing a logged in user.
getSessionByUrl
Class MethodgetSessionByUrl(url: string): UserSessionReturn session by url.
Parameters
| Parameter | Type | Notes |
|---|---|---|
url | string |
Returns
UserSession(https://esri.github.io/arcgis-rest-js/api/auth/UserSession) representing a logged in user.
getSessionKeyFromSession
Class MethodgetSessionKeyFromSession(session: UserSession): stringGet session key from a session.
Parameters
| Parameter | Type | Notes |
|---|---|---|
session | UserSession | A session of ArcGIS REST JS 'UserSession' representing a logged in user. |
Returns
stringgetSessions
Class MethodgetSessions(): UserSession[]Return all sessions.
Returns
UserSession[]Array of ArcGIS REST JS 'UserSession' representing the logged in users.
getSignInErrorByCode
Class MethodgetSignInErrorByCode(errorCode: SignInErrorCode): SignInErrorGet the sign-in error by providing the sign-in error code.
Parameters
| Parameter | Type | Notes |
|---|---|---|
error | SignInErrorCode | The sign-in error code. |
Returns
SignInErrorgetSignInErrorCodeByAuthError
Class MethodgetSignInErrorCodeByAuthError(error: any): SignInErrorCodeGet the sign-in error by providing the authentication error.
Parameters
| Parameter | Type | Notes |
|---|---|---|
error | any |
|
Returns
SignInErrorCodehandleAuthError
Class MethodhandleAuthError(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
| Parameter | Type | Default |
|---|---|---|
error | any | |
popup | boolean | true |
Returns
Promise<UserSession>removeSession
Class MethodremoveSession(session: UserSession): booleanRemove the session from session manager.
Parameters
| Parameter | Type | Notes |
|---|---|---|
session | UserSession | A session of ArcGIS REST JS 'UserSession' representing a logged in user. |
Returns
booleansignIn
Class MethodsignIn(fromUrl: string, popup: boolean, desUrl: string, clientId?: string, forceLogin?: boolean): Promise<UserSession>Start OAuth sign in flow and return the user session.
Parameters
| Parameter | Type | Default | Notes |
|---|---|---|---|
from | string | window.jimu | The page you start sign in |
popup | boolean | true | If 'true', the window will popup, or, it will redirect to sign in page |
des | string | ... | The url you want to sign in |
client | string | | |
force | boolean | |
Returns
Promise<UserSession>useDialogToSetClientIdToConnectiosOfAppConfigAndSignIn
Class MethoduseDialogToSetClientIdToConnectiosOfAppConfigAndSignIn(portalUrl: string, needToSignIn?: boolean, serviceUrl?: string): Promise<any>Popup a dialog to set client id to app config
Parameters
| Parameter | Type | Notes |
|---|---|---|
portal | string | portal url |
need | boolean | indicates whether need to sign-in |
service | string | service url |
Returns
Promise<any>getInstance
getInstance(): SessionManagerGet singleton instance.
Returns
SessionManager