Constructor Parameters

Parameter Type Default Notes
opts Required IArcGISContextStateOptions


Property Type Notes
id number


Accessor Type Notes
communityOrgHostname string
communityOrgId string

Return Hub Community Org Id, if defined

communityOrgUrl string
currentUser IUser
discussionsServiceUrl string
domainServiceUrl string
eventsConfig any
helperServices any
hubEnabled boolean

Returns boolean indicating if the current user belongs to an organization that has licensed ArcGIS Hub

hubRequestOptions IHubRequestOptions

Return a IHubRequestOptions object

hubSearchServiceUrl string
hubUrl string
isAuthenticated boolean

Return boolean indicating if authenticatio is present

isPortal boolean

Returns boolean indicating if the backing system is ArcGIS Enterprise (formerly ArcGIS Portal) or not

portal IPortal
portalUrl string

Return the portal url.

requestOptions IRequestOptions

Return IRequestOptions, which is used by REST-JS functions which may use authentication information if provided.

session UserSession

Return the UserSession if authenticated

sharingApiUrl string

Returns the url to the sharing api i.e.

userRequestOptions IUserRequestOptions

Return IUserRequestOptions, which is used for REST-JS functions which require authentication information.

Class defined in common/src/ArcGISContextState.ts:70