Class ArcGISPortal
The ArcGISPortal class is part of the Portal API which provides a way to build applications that work with content from ArcGIS Online or an ArcGIS Portal.
Namespace: Esri.ArcGISRuntime.Portal
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class ArcGISPortal : ICoreInstanceOwnerRemarks
ArcGIS Portal is software technology from Esri that customers can deploy either on premise or in the cloud. ArcGIS Online is Esri's Software as a Service offering that represents GIS as a Service and is implemented using the same technology as ArcGIS Portal. The Portal API allows application developers to work with users, groups and content hosted within ArcGIS Online or within an ArcGIS Portal. The API allows developers to build web, mobile, and desktop applications that support sharing and collaboration using web maps. Organizational developers can also use the API to build custom applications for their users. The Portal class provides the connection information to the portal (Uri, Token, ClientAppType, CultureInfo). Once instantiated by calling the static factory CreateAsync(), PortalInfo and User are available and provide information about the portal and the current user.
This class is needed to instantiate all others classes of the Portal library.
Properties
| Name | Description |
|---|---|
| Credential | Gets or sets the security credential used to access the portal. |
| CultureInfo | Gets the culture info used to access the portal. Must be set using the appropriate CreateAsync method. This locale might be used by the REST service to provide customized or localized content (featured groups/items etc) for different locales. |
| PortalInfo | Gets the PortalInfo object for this ArcGIS Portal. |
| Uri | Gets the URI of the ArcGIS 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.
If the URI is |
| CreateAsync(Uri, Credential) | Creates asynchronously a new instance of the ArcGISPortal class.
If the URI is |
| CreateAsync(Uri, Credential, CancellationToken) | Creates asynchronously a new instance of the ArcGISPortal class.
If the URI is |
| 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, Credential) | Creates asynchronously a new instance of the ArcGISPortal class.
If the URI is |
| CreateAsync(Uri, CultureInfo, Credential, CancellationToken) | Creates asynchronously a new instance of the ArcGISPortal class.
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. |
| GetHomePageFeaturedContentAsync() | Searches the home page featured content asynchronously. This method uses the HomePageFeaturedContentGroupQuery and returns the corresponding PortalItem collection. |
| GetHomePageFeaturedContentAsync(CancellationToken) | Searches the home page featured content asynchronously. This method uses the HomePageFeaturedContentGroupQuery and returns the corresponding PortalItem collection. |
| GetLicenseInfoAsync() | Executes a portal query that gets the current user's License Info 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.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0 |
| .NET Framework | 100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0 |
| .NET 5 | 100.12.0, 100.11.0, 100.10.0 |
| .NET Core | 100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0 |
| Xamarin.Android | 100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0 |
| Xamarin.iOS | 100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0 |
| UWP | 100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0 |