SessionManager

Class

The SessionManager is used to manage user sign in sessions.

Methods

Method	Returns	Notes
`clearSessions()`	`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
`getMainSession()`	`UserSession`	Return main session.
`getSessionByUrl(url)`	`UserSession`	Return session by url.
`getSessionKeyFromSession(session)`	`string`	Get session key from a session.
`getSessions()`	`UserSession[]`	Return all sessions.
`getSignInErrorByCode(errorCode)`	`SignInError`	Get the sign-in error by providing the sign-in error code.
`getSignInErrorCodeByAuthError(error)`	`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
`getInstance()`	`SessionManager`	Get singleton instance.

clearSessions

Class Method

clearSessions(): void

Clear all sessions

Returns

void

generateSeverSessionByPortalSession

Class Method

generateSeverSessionByPortalSession(portalSession: UserSession, serverUrl: string, credentialsParamForGenerateToken: string): Promise<UserSession>

Generate server session with owning system portal session.

Parameters

Parameter	Type	Default	Notes
`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(portalUrl: string, getTokenParam: string, credentialsParam: string): Promise<any>

Generate token.

Parameters

Parameter	Type	Default
`portalUrl`	string
`getTokenParam`	string	`''`
`credentialsParam`	string

Returns

Promise<any>

getClientIdByUrl

Class Method

getClientIdByUrl(portalUrl: string): string

Get a valid client id for portal url

Parameters

Parameter	Type
`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

(https://esri.github.io/arcgis-rest-js/api/auth/UserSession) representing a logged in user.

getSessionByUrl

Class Method

getSessionByUrl(url: string): UserSession

Return 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 Method

getSessionKeyFromSession(session: UserSession): string

Get session key from a session.

Parameters

Parameter	Type	Notes
`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(errorCode: SignInErrorCode): SignInError

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

Parameters

Parameter	Type	Notes
`errorCode`	SignInErrorCode	The sign-in error code.

Returns

SignInError

getSignInErrorCodeByAuthError

Class Method

getSignInErrorCodeByAuthError(error: any): SignInErrorCode

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

Parameters

Parameter	Type	Notes
`error`	any	`ArcGISRequestError` or `ArcGISAuthError`

Returns

SignInErrorCode

handleAuthError

Class Method

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

Parameter	Type	Default
`error`	any
`popup`	boolean	`true`

Returns

Promise<UserSession>

removeSession

Class Method

removeSession(session: UserSession): boolean

Remove the session from session manager.

Parameters

Parameter	Type	Notes
`session`	UserSession	A session of ArcGIS REST JS 'UserSession' representing a logged in user.

Returns

boolean

Class Method

signIn(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
`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

Returns

Promise<UserSession>

signOut

Class Method

signOut(): void

Sign out from main portal.

Returns

void

useDialogToSetClientIdToConnectiosOfAppConfigAndSignIn

Class Method

useDialogToSetClientIdToConnectiosOfAppConfigAndSignIn(portalUrl: string, needToSignIn?: boolean, serviceUrl?: string): Promise<any>

Popup a dialog to set client id to app config

Parameters

Parameter	Type	Notes
`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

ArcGIS Experience BuilderAPI Reference

SessionManager

Was this page helpful?

Was this page helpful?