IArcGISContext
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 |
---|---|---|
string |
Returns the Community Org Hostname, if defined |
|
string |
Return Hub Community Org Id, if defined |
|
string |
Returns the Hub Community Org url |
|
IUser |
Returns the current user |
|
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 |
|
string |
Returns the current user's hub-home url. If not authenticated, returns the Hub Url. If portal, returns undefined |
|
HubLicense |
What is the current user's hub license level? |
|
IHubRequestOptions |
Return a |
|
string |
Returns the Hub Search API URL |
|
string |
Returns the Hub url, based on the portalUrl |
|
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. |
|
boolean |
Is this user in a Hub Alpha org? Derived from 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 |
|
string |
Return the portal url. |
|
Record<stringany> |
Additional app-specific context |
|
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 |
System status |
|
IUserRequestOptions |
Return |
Interface defined in common/src/ArcGISContext.ts:32