SessionManager | ArcGIS Experience Builder

Class

The SessionManager is used to manage user sign in sessions.

Methods

Method	Returns	Notes
`addFromCredential(credential, from, serverInfo?, oAuthInfo?)`	`Promise<ArcGISIdentityManager>`	Create a session from ArcGIS Maps SDK for JavaScript credential
`clearSessions()`	`void`	Clear all sessions from session manager, the tokens are not be revoked
`generateSeverSessionByPortalSession(portalSession, serverUrl, credentialsParamForGenerateToken)`	`Promise<ArcGISIdentityManager>`	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()`	`ArcGISIdentityManager`	Return main session.
`getSessionByUrl(url)`	`ArcGISIdentityManager`	Return session by url.
`getSessionKeyFromSession(session)`	`string`	Get session key from a session.
`getSessions()`	`ArcGISIdentityManager[]`	Return all sessions.
`getSessionType(session)`	`SessionType`	Return session type according to a session
`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(handleAuthErrorParams)`	`Promise<ArcGISIdentityManager>`	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 if the 'gotoSignInDirectly' property is true. Otherwise, it will just handle the token error by different scenarios: 498: token invalided, go to system error page; token expired: show runtime error dialog to remind user to re-sign in; app item does not exist (item is deleted) or is inaccessible: show runtime error reminder.
`isMainSession(session)`	`boolean`	Return true if the session is a main session and is valid.
`isMainSessionExpired()`	`boolean`	Return true if the session is existed and is expired
`isSameSession(session1, session2)`	`boolean`	Return true if the two sessions are equal.
`isSignInPromptBlocked()`	`boolean`	return true if the sign-in prompt is blocked only effects on app env, always return false in builder env
`isValidTokenFromStorage(portalUrl)`	`Promise<boolean>`	Sends a request to check the token of the session from storage.
`nonOAuthSignIn(desUrl, forceLogin?)`	`Promise<any>`	Start non-OAuth sign in flow and return the user session. It use esri request to sign-in resource
`removeSession(session)`	`boolean`	Remove the session from session manager and revoke token of session. So, deleting a session means signing out. Note: token of stand-alone server session will be destroyed when syncing to 'arcgis-dependency-extension'
`signIn(signInParams)`	`Promise<ArcGISIdentityManager>`	Start OAuth2 sign-in flow and return the user session.
`signInByResourceUrl(resourceUrl, owningSystemUrl?, forceLogin?)`	`Promise<ArcGISIdentityManager>`	Start sign in flow by a resource url and return the user session.
`signOut(signOutParams)`	`void`	Start OAuth2 sign-out flow
`signOutByResourceUrl(resourceUrl, owningSystemUrl?)`	`void`	Start a sign-out flow by a resource url without page redirects or refreshes
`switchAccount(switchAccountParams)`	`Promise<ArcGISIdentityManager>`	Start OAuth2 switch account flow and return the user session.
`switchAccountByResourceUrl(resourceUrl, owningSystemUrl?)`	`Promise<ArcGISIdentityManager>`	Start switch account flow by a resource url and return the user session.
`useDialogToSetClientIdToConnectionsOfAppConfig(portalUrl)`	`Promise<any>`	Popup a dialog to set client id to app config
`getInstance()`	`SessionManager`	Get singleton instance.

addFromCredential

Class Method

addFromCredential(credential: ICredential | Credential, from: SessionChangedReasonType, serverInfo?: ArcGISServerInfo, oAuthInfo?: any): Promise<ArcGISIdentityManager>

Create a session from ArcGIS Maps SDK for JavaScript credential

Parameters

Parameter	Type
`credential`	ICredential \| Credential
`from`	SessionChangedReasonType
`serverInfo`	ArcGISServerInfo
`oAuthInfo`	any

Returns

Promise<ArcGISIdentityManager>

clearSessions

Class Method

clearSessions(): void

Clear all sessions from session manager, the tokens are not be revoked

Returns

void

generateSeverSessionByPortalSession

Class Method

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

Generate server session with owning system portal session.

Parameters

Parameter	Type	Default	Notes
`portalSession`	ArcGISIdentityManager		A session of ArcGIS REST JS 'ArcGISIdentityManager' representing a logged in user.
`serverUrl`	string
`credentialsParamForGenerateToken`	string	`'same-origin'`

Returns

Promise<ArcGISIdentityManager>

generateToken

Class Method

generateToken(portalUrl: string, getTokenParam: string, credentialsParam: string): Promise<any>

Generate token.

Parameters

Parameter	Type	Default
`portalUrl`	string
`getTokenParam`	string	`''`
`credentialsParam`	string	`'same-origin'`

Returns

Promise<any>

getClientIdByUrl

Class Method

getClientIdByUrl(portalUrl: string): string

Get a valid client id for portal url

Parameters

Parameter	Type	Notes
`portalUrl`	string	portal url

Returns

string

getMainSession

Class Method

getMainSession(): ArcGISIdentityManager

Return main session.

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

Returns

ArcGISIdentityManager

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

getSessionByUrl

Class Method

getSessionByUrl(url: string): ArcGISIdentityManager

Return session by url.

Parameters

Parameter	Type
`url`	string

Returns

ArcGISIdentityManager

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

getSessionKeyFromSession

Class Method

getSessionKeyFromSession(session: ArcGISIdentityManager): string

Get session key from a session.

Parameters

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

Returns

string

getSessions

Class Method

getSessions(): ArcGISIdentityManager[]

Return all sessions.

Returns

ArcGISIdentityManager[]

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

getSessionType

Class Method

getSessionType(session: ArcGISIdentityManager): SessionType

Return session type according to a session

Parameters

Parameter	Type
`session`	ArcGISIdentityManager

Returns

SessionType

getSignInErrorByCode

Class Method

getSignInErrorByCode(errorCode: SignInErrorCode): SignInError

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

Parameters

Parameter	Type	Default	Notes
`errorCode`	SignInErrorCode	`SignInErrorCode.Other`	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(handleAuthErrorParams: HandleAuthErrorParams): Promise<ArcGISIdentityManager>

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 if the 'gotoSignInDirectly' property is true. Otherwise, it will just handle the token error by different scenarios: 498: token invalided, go to system error page; token expired: show runtime error dialog to remind user to re-sign in; app item does not exist (item is deleted) or is inaccessible: show runtime error reminder.

Parameters

Parameter	Type
`handleAuthErrorParams`	HandleAuthErrorParams

Returns

Promise<ArcGISIdentityManager>

isMainSession

Class Method

isMainSession(session: ArcGISIdentityManager): boolean

Return true if the session is a main session and is valid.

Parameters

Parameter	Type
`session`	ArcGISIdentityManager

Returns

boolean

isMainSessionExpired

Class Method

isMainSessionExpired(): boolean

Return true if the session is existed and is expired

Returns

boolean

isSameSession

Class Method

isSameSession(session1: ArcGISIdentityManager, session2: ArcGISIdentityManager): boolean

Return true if the two sessions are equal.

Parameters

Parameter	Type
`session1`	ArcGISIdentityManager
`session2`	ArcGISIdentityManager

Returns

boolean

isSignInPromptBlocked

Class Method

isSignInPromptBlocked(): boolean

return true if the sign-in prompt is blocked only effects on app env, always return false in builder env

Returns

boolean

isValidTokenFromStorage

Class Method

isValidTokenFromStorage(portalUrl: string): Promise<boolean>

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

Parameters

Parameter	Type
`portalUrl`	string

Returns

Promise<boolean>

nonOAuthSignIn

Class Method

nonOAuthSignIn(desUrl: string, forceLogin?: boolean): Promise<any>

Start non-OAuth sign in flow and return the user session. It use esri request to sign-in resource

Parameters

Parameter	Type	Notes
`desUrl`	string	The url you want to sign in
`forceLogin`	boolean

Returns

Promise<any>

removeSession

Class Method

removeSession(session: ArcGISIdentityManager): boolean

Remove the session from session manager and revoke token of session. So, deleting a session means signing out. Note: token of stand-alone server session will be destroyed when syncing to 'arcgis-dependency-extension'

Parameters

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

Returns

boolean

Class Method

signIn(signInParams: SignInParams): Promise<ArcGISIdentityManager>

Start OAuth2 sign-in flow and return the user session.

Parameters

Parameter	Type	Default	Notes
`signInParams`	SignInParams	`{}`	The properties for sign-in.

Returns

Promise<ArcGISIdentityManager>

signInByResourceUrl

Class Method

signInByResourceUrl(resourceUrl: string, owningSystemUrl?: string, forceLogin?: boolean): Promise<ArcGISIdentityManager>

Start sign in flow by a resource url and return the user session.

Parameters

Parameter	Type	Notes
`resourceUrl`	string	a resource url can be: service url: federated or non-federated; portal item url;
`owningSystemUrl`	string	owning system url for federated service url
`forceLogin`	boolean

Returns

Promise<ArcGISIdentityManager>

signOut

Class Method

signOut(signOutParams: SignOutParams): void

Start OAuth2 sign-out flow

Parameters

Parameter	Type	Default	Notes
`signOutParams`	SignOutParams	`{}`	The properties for sign-out.

Returns

void

signOutByResourceUrl

Class Method

signOutByResourceUrl(resourceUrl: string, owningSystemUrl?: string): void

Start a sign-out flow by a resource url without page redirects or refreshes

Parameters

Parameter	Type	Notes
`resourceUrl`	string	a resource url can be: service url: federated or non-federated; portal item url;
`owningSystemUrl`	string	owning system url for federated service url

Returns

void

switchAccount

Class Method

switchAccount(switchAccountParams: SwitchAccountParams): Promise<ArcGISIdentityManager>

Start OAuth2 switch account flow and return the user session.

Parameters

Parameter	Type	Default	Notes
`switchAccountParams`	SwitchAccountParams	`{}`	The properties for switching account.

Returns

Promise<ArcGISIdentityManager>

switchAccountByResourceUrl

Class Method

switchAccountByResourceUrl(resourceUrl: string, owningSystemUrl?: string): Promise<ArcGISIdentityManager>

Start switch account flow by a resource url and return the user session.

Parameters

Parameter	Type	Notes
`resourceUrl`	string	a resource url can be: service url: federated or non-federated; portal item url;
`owningSystemUrl`	string	owning system url for federated service url

Returns

Promise<ArcGISIdentityManager>

useDialogToSetClientIdToConnectionsOfAppConfig

Class Method

useDialogToSetClientIdToConnectionsOfAppConfig(portalUrl: string): Promise<any>

Popup a dialog to set client id to app config

Parameters

Parameter	Type	Notes
`portalUrl`	string	portal url

Returns

Promise<any>

getInstance

static

Class Method

getInstance(): SessionManager

Get singleton instance.

Returns

SessionManager