SessionManager

Class

The SessionManager is used to manage user sign in sessions.

Methods

MethodReturnsNotes
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.

UserSession

Return session by url.

string

Get session key from a session.

UserSession[]

Return all sessions.

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.

Promise<boolean>

Sends a request to check the token of the session from storage.

Promise<any>

Start non-OAuth sign in flow and return the user session.

removeSession(session)
boolean

Remove the session from session manager.

signIn(fromUrl, popup, desUrl, clientId?, forceLogin?, federatedServcieUrl?)
Promise<UserSession>

Start OAuth sign in flow and return the user session.

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.

clearSessions

Class Method
clearSessions(): void

Clear all sessions

Returns 
void

generateSeverSessionByPortalSession

Class Method
generateSeverSessionByPortalSession(portalSessionUserSession, serverUrlstring, credentialsParamForGenerateTokenstring): Promise<UserSession>

Generate server session with owning system portal session.

Parameters
ParameterTypeDefaultNotes
portalSession
UserSession

A session of ArcGIS REST JS 'UserSession' representing a logged in user.

serverUrl
string
credentialsParamForGenerateToken
string
'same-origin'
Returns 
Promise<UserSession>

generateToken

Class Method
generateToken(portalUrlstring, getTokenParamstring, credentialsParamstring): Promise<any>

Generate token.

Parameters
ParameterTypeDefault
portalUrl
string
getTokenParam
string
''
credentialsParam
string
Returns 
Promise<any>

getClientIdByUrl

Class Method
getClientIdByUrl(portalUrlstring): string

Get a valid client id for portal url

Parameters
ParameterType
portalUrl
string
Returns 
string

getMainSession

Class Method
getMainSession(): UserSession

Return main session.

The main session is session of the portal that the app connects to.

Returns 
UserSession

ArcGIS REST JS 'UserSession' representing a logged in user.

getSessionByUrl

Class Method
getSessionByUrl(urlstring): UserSession

Return session by url.

Parameters
ParameterType
url
string
Returns 
UserSession

ArcGIS REST JS 'UserSession' representing a logged in user.

getSessionKeyFromSession

Class Method
getSessionKeyFromSession(sessionUserSession): string

Get session key from a session.

Parameters
ParameterTypeNotes
session
UserSession

A session of ArcGIS REST JS 'UserSession' representing a logged in user.

Returns 
string

getSessions

Class Method
getSessions(): UserSession[]

Return all sessions.

Returns 
UserSession[]

Array of ArcGIS REST JS 'UserSession' representing the logged in users.

getSignInErrorByCode

Class Method
getSignInErrorByCode(errorCodeSignInErrorCode): SignInError

Get the sign-in error by providing the sign-in error code.

Parameters
ParameterTypeNotes
errorCode
SignInErrorCode

The sign-in error code.

Returns 
SignInError

getSignInErrorCodeByAuthError

Class Method
getSignInErrorCodeByAuthError(errorany): SignInErrorCode

Get the sign-in error by providing the authentication error.

Parameters
ParameterTypeNotes
error
any

ArcGISRequestError or ArcGISAuthError

Returns 
SignInErrorCode

handleAuthError

Class Method
handleAuthError(errorany, popupboolean): 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
ParameterTypeDefault
error
any
popup
boolean
true
Returns 
Promise<UserSession>

isValidTokenFromStorage

Class Method
isValidTokenFromStorage(portalUrlstring): Promise<boolean>

Sends a request to check the token of the session from storage.

Parameters
ParameterType
portalUrl
string
Returns 
Promise<boolean>

nonOAuthSignIn

Class Method
nonOAuthSignIn(desUrlany): Promise<any>

Start non-OAuth sign in flow and return the user session.

Parameters
ParameterTypeNotes
desUrl
any

The url you want to sign in

Returns 
Promise<any>

removeSession

Class Method
removeSession(sessionUserSession): boolean

Remove the session from session manager.

Parameters
ParameterTypeNotes
session
UserSession

A session of ArcGIS REST JS 'UserSession' representing a logged in user.

Returns 
boolean

signIn

Class Method
signIn(fromUrlstring, popupboolean, desUrlstring, clientId?string, forceLogin?boolean, federatedServcieUrl?string): Promise<UserSession>

Start OAuth sign in flow and return the user session.

Parameters
ParameterTypeDefaultNotes
fromUrl
string
window.jimuConfig.mountPath

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
string
forceLogin
boolean
federatedServcieUrl
string
Returns 
Promise<UserSession>

signOut

Class Method
signOut(): void

Sign out from main portal.

Returns 
void

useDialogToSetClientIdToConnectiosOfAppConfigAndSignIn

Class Method
useDialogToSetClientIdToConnectiosOfAppConfigAndSignIn(portalUrlstring, needToSignIn?boolean, serviceUrl?string): Promise<any>

Popup a dialog to set client id to app config

Parameters
ParameterTypeNotes
portalUrl
string

portal url

needToSignIn
boolean

indicates whether need to sign-in

serviceUrl
string

service url

Returns 
Promise<any>

getInstance

static
Class Method
getInstance(): SessionManager

Get singleton instance.

Returns 
SessionManager

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.