IArcGISContext

Interface

Defines the properties of the ArcGISContext. Typically components or functions will get an instance of ArcGISContext from ArcGISContetManager.

ArcGISContext implements this interface, and uses getters to simplify the derivation of various complex properties.

Properties

Property	Type	Notes
communityOrgHostname	string	Returns the Community Org Hostname, if defined
communityOrgId	string	Return Hub Community Org Id, if defined
communityOrgUrl	string	Returns the Hub Community Org url
currentUser	IUser	Returns the current user
discussionsServiceUrl	string	Returns the discussions API URL
domainServiceUrl	string	Returns Hub Domain Service URL
environment	HubEnvironment	What environment is this running in?
eventsConfig	any	Returns the Events configuration object from portal/self
featureFlags	IFeatureFlags	Hash of feature flags
helperServices	any	Returns the hash of helper services from portal self
hubEnabled	boolean	Returns boolean indicating if the current user belongs to an organization that has licensed ArcGIS Hub
hubHomeUrl	string	Returns the current user's hub-home url. If not authenticated, returns the Hub Url. If portal, returns undefined
hubLicense	HubLicense	What is the current user's hub license level?
hubRequestOptions	IHubRequestOptions	Return a `IHubRequestOptions` object
hubSearchServiceUrl	string	Returns the Hub Search API URL
hubUrl	string	Returns the Hub url, based on the portalUrl
id	number	Unique id from the ArcGISContextManager that created this instance. Primarily useful for debugging possible race-conditions that can result in multiple ArcGISContextManager instances being created.
isAlphaOrg	boolean	Is this user in a Hub Alpha org? Derived from properties.alphaOrgs
isAuthenticated	boolean	Return boolean indicating if authenticatio is present
isBetaOrg	boolean	Is this user in a Hub Beta org? Derived from properties.betaOrgs
isPortal	boolean	Returns boolean indicating if the backing system is ArcGIS Enterprise (formerly ArcGIS Portal) or not
portal	IPortal	Returns the portal object
portalUrl	string	Return the portal url.
properties	Record<stringany>	Additional app-specific context
requestOptions	IRequestOptions	Return `IRequestOptions`, which is used by REST-JS functions which may use authentication information if provided.
serviceStatus	HubServiceStatus	Hub Service Status
session	UserSession	Return the UserSession if authenticated
sharingApiUrl	string	Returns the url to the sharing api composed from portalUrl i.e. https://myorg.maps.arcgis.com/sharing/rest
trustedOrgIds	string[]	Array of Trusted Org Ids
trustedOrgs	IHubTrustedOrgsResponse[]	Trusted orgs xhr response
userRequestOptions	IUserRequestOptions	Return `IUserRequestOptions`, which is used for REST-JS functions which require authentication information.

Interface defined in common/src/ArcGISContext.ts:33