Class ArcGISPortal
The entry point into the ArcGIS portal services hosted by ArcGIS Online and ArcGIS Enterprise.
Inheritance
Namespace: Esri.ArcGISRuntime.Portal
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class ArcGISPortalRemarks
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 a 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 ArcGISPortal 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 ArcGISPortal 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 topic in the developer guide.
Properties
| Name | Description |
|---|---|
| CultureInfo | Gets the information that specifies culture-specific formatting to use when accessing ArcGISPortal content. Must be set using the appropriate CreateAsync method. |
| PortalInfo | Gets the details about this ArcGISPortal, such as the name, logo, featured items and supported protocols (http vs https). |
| Uri | Gets the URI of this portal. |
| User | Gets the current user. Available only to authenticated users after initialization. |
Methods
| Name | Description |
|---|---|
| CreateAsync() | Creates asynchronously a new instance of the ArcGISPortal class that represents ArcGIS Online (i.e https://www.arcgis.com as Portal Uri). |
| CreateAsync(CancellationToken) | Creates asynchronously a new instance of the ArcGISPortal class that represents ArcGIS Online (i.e https://www.arcgis.com as Portal Uri). |
| CreateAsync(Uri) | Creates asynchronously a new instance of the ArcGISPortal class from the specified portal Uri. |
| CreateAsync(Uri, Boolean) | Creates asynchronously a new instance of the ArcGISPortal class.
If the URI is |
| CreateAsync(Uri, Boolean, CultureInfo) | Creates asynchronously a new instance of the ArcGISPortal class.
If the URI is |
| CreateAsync(Uri, Boolean, CultureInfo, CancellationToken) | Creates asynchronously a new instance of the ArcGISPortal class.
If the URI is |
| CreateAsync(Uri, Boolean, CancellationToken) | Creates asynchronously a new instance of the ArcGISPortal class.
If the URI is |
| CreateAsync(Uri, CultureInfo) | Creates asynchronously a new instance of the ArcGISPortal class from the specified portal Uri.
If the URI is |
| CreateAsync(Uri, CultureInfo, CancellationToken) | Creates asynchronously a new instance of the ArcGISPortal class from the specified portal Uri.
If the URI is |
| CreateAsync(Uri, CancellationToken) | Creates asynchronously a new instance of the ArcGISPortal class from the specified portal Uri.
If the URI is |
| FindGroupsAsync(PortalQueryParameters) | Finds portal groups from a query string. |
| FindGroupsAsync(PortalQueryParameters, CancellationToken) | Finds portal groups that match the query parameters specified. |
| FindItemsAsync(PortalQueryParameters) | Finds portal items that match the query parameters specified. |
| FindItemsAsync(PortalQueryParameters, CancellationToken) | Finds portal items that match the query parameters specified |
| FindUsersAsync(PortalQueryParameters) | Finds portal users that match the query parameters specified. |
| FindUsersAsync(PortalQueryParameters, CancellationToken) | Finds portal users that match the query parameters specified. |
| GetBasemapsAsync() | Executes a portal query with the BasemapGalleryGroupQuery query string and returns the resulting collection of Basemap objects. |
| GetBasemapsAsync(CancellationToken) | Executes a portal query with the BasemapGalleryGroupQuery query string and returns the resulting collection of Basemap objects. |
| GetDeveloperBasemapsAsync() | Executes a portal query to fetch the developer basemaps for this portal. |
| GetDeveloperBasemapsAsync(CancellationToken) | Executes a portal query to fetch the developer basemaps for this portal. |
| GetFeaturedGroupsAsync() | Gets the featured groups for the organization. This method uses the FeaturedGroupsQueries and returns the corresponding collection of PortalGroup. |
| GetFeaturedGroupsAsync(CancellationToken) | Gets the featured groups for the organization. This method uses the FeaturedGroupsQueries and returns the corresponding collection of PortalGroup. |
| GetFeaturedItemsAsync() | Gets the featured items asynchronously. This method uses the FeaturedItemsGroupQuery and returns the corresponding collection of PortalItem objects within the matching group. |
| GetFeaturedItemsAsync(CancellationToken) | Gets the featured items asynchronously. This method uses the FeaturedItemsGroupQuery and returns the corresponding collection of PortalItem objects within the matching group. |
| GetLicenseInfoAsync() | Retrieves the current portal user's LicenseInfo, including the entitlements and extensions. |
| GetLoginTypeForUriAsync(Uri) | Retrieves the PortalLoginType for the specified portal Uri. |
| GetLoginTypeForUriAsync(Uri, CancellationToken) | Retrieves the PortalLoginType for the specified portal Uri. |
| GetStylesAsync() | Executes a portal query with the StylesGroupQuery query string. |
| GetStylesAsync(CancellationToken) | Executes a portal query with the StylesGroupQuery query string. |
| GetSymbolSetsAsync() | Executes a portal query with the SymbolSetsGroupQuery query string. |
| GetSymbolSetsAsync(CancellationToken) | Executes a portal query with the SymbolSetsGroupQuery query string. |
| GetVectorBasemapsAsync() | Executes a portal query with the VectorBasemapGalleryGroupQuery query string and returns the resulting collection of Basemap objects. |
| GetVectorBasemapsAsync(CancellationToken) | Executes a portal query with the VectorBasemapGalleryGroupQuery query string and returns the resulting collection of Basemap objects. |
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.5 |
| .NET | 100.13 - 200.5 |
| .NET Windows | 100.13 - 200.5 |
| .NET Android | 200.0 - 200.5 |
| .NET iOS | 200.0 - 200.5 |
| .NET Framework | 100.0 - 200.5 |
| Xamarin.Android | 100.0 - 100.15 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.5 |