Portal class final
The entry point into the ArcGIS portal services hosted by ArcGIS Online and ArcGIS Enterprise.
ArcGIS portals are geospatial content management systems from ESRI that customers can use to securely store, manage, and access different types of content. There are two types of portals:
- ArcGIS Online portal - a service hosted by Esri that you can access with an ArcGIS Developer account or ArcGIS Online account.
- ArcGIS Enterprise portal - a service hosted by ArcGIS Enterprise that you can access with an ArcGIS Enterprise account.
The Portal class is the main entry point into the ArcGIS Portal Directory REST API that allows you to work with users, groups and content hosted within ArcGIS Online or ArcGIS Enterprise portals. Once instantiated, you can use the Portal to search for items and groups and see portal content, such as services, layers, and so on.
For more information about authenticating your app or its users with a portal, see the Introduction to security and authentication.
- Implemented types
- Mixed in types
Constructors
- Portal(Uri uri, {PortalConnection connection = PortalConnection.anonymous})
-
Creates a portal object.
factory
- Portal.arcGISOnline({PortalConnection connection = PortalConnection.anonymous})
-
Creates a portal instance pointing to https://www.arcgis.com.
factory
Properties
- connection → PortalConnection
-
The connection type used while loading the portal.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- loadError → ArcGISException?
-
The load error.
no setterinherited
- loadStatus → LoadStatus
-
The load status.
no setterinherited
-
onLoadStatusChanged
→ Stream<
LoadStatus> -
A stream that reports changes to the
LoadStatus.no setterinherited - portalInfo → PortalInfo?
-
Details about the Portal instance, such as its name, logo, featured
items, and supported protocols (http vs https).
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- uri → Uri
-
The URL of this portal.
no setter
- user → PortalUser?
-
The authenticated user of this portal.
no setter
Methods
-
basemaps(
) → Future< List< Basemap> > - A Future that completes with an array of Basemap objects within the basemap gallery group. See PortalInfo.basemapGalleryGroupQuery.
-
cancelLoad(
) → void -
Cancels loading metadata for the object.
inherited
-
developerBasemaps(
) → Future< List< Basemap> > - A Future that completes with an array of Basemap objects within the developer basemap gallery group. See PortalInfo.developerBasemapGalleryGroupQuery.
-
fetchLicenseInfo(
) → Future< LicenseInfo> -
Retrieves the current portal user's
LicenseInfoincluding its entitlements and extensions. -
fetchLicenseInfoCancelable(
) → CancelableOperation< LicenseInfo> - Cancelable version of fetchLicenseInfo. See that method for more information.
-
fetchStyles(
) → Future< List< PortalItem> > - Retrieves a collection of styles using the PortalInfo.stylesGroupQuery query string.
-
findGroups(
{required PortalQueryParameters parameters}) → Future< PortalQueryResultSet< PortalGroup> > - Finds portal groups that match the given query parameters.
-
findItems(
{required PortalQueryParameters parameters}) → Future< PortalQueryResultSet< PortalItem> > - Finds portal items that match the specified query parameters.
-
load(
) → Future< void> -
Loads the metadata for the object asynchronously.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
retryLoad(
) → Future< void> -
Loads or retries loading metadata for the object asynchronously.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited