ArcGISContext
Abstraction that holds a UserSession
, along with
getters to streamline access to various platform
urls, and common constructs like IRequestOptions
,
IUserRequestOptions
etc.
Instances are intended to be immutable, but this is not directly enforced.
In most circumstances, this class should be created by the ArcGISContextManager class.
Implements
Constructors
Constructor Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
opts Required | IArcGISContextOptions |
Properties
Accessors
Accessor | Type | Notes |
---|---|---|
string |
Returns the Hub Community Org Hostname, if defined |
|
string |
Return the Hub Community Org Id, if defined |
|
string |
Returns the Hub Community Org url |
|
IUser |
Returns the current user as IUser |
|
string |
Returns the discussions API URL |
|
string |
Returns Hub Domain Service URL |
|
any |
Returns the Events configuration object from portal/self |
|
any |
Returns the hash of helper services from portal self |
|
boolean |
Returns boolean indicating if the current user belongs to an organization that has licensed ArcGIS Hub |
|
HubLicense |
Returns the current user's Hub License |
|
IHubRequestOptions |
Return a |
|
string |
Returns the Hub Search API URL |
|
string |
Returns the Hub url, based on the portalUrl |
|
boolean |
Is the users org in the alpha orgs list? Alpha orgs are passed in via properties.alphaOrgs |
|
boolean |
Return boolean indicating if authenticatio is present |
|
boolean |
Returns boolean indicating if the backing system is ArcGIS Enterprise (formerly ArcGIS Portal) or not |
|
IPortal |
Returns the portal object as IPortal |
|
string |
Return the portal url i.e. https://www.arcgis.com |
|
Record<stringany> |
Return the properties hash that was passed in. Useful for app-specific context such as the active Site for ArcGIS Hub |
|
IRequestOptions |
Return |
|
UserSession |
Return the UserSession if authenticated |
|
string |
Returns the url to the sharing api composed from portalUrl i.e. https://myorg.maps.arcgis.com/sharing/rest |
|
HubSystemStatus |
Returns the current hub system status information |
|
IUserRequestOptions |
Return |
Class defined in common/src/ArcGISContext.ts:233