Show / Hide Table of Contents

Class PortalInfo

Includes information such as the name, logo, featured items and supported protocols (http vs https) for this portal.

Inheritance
Object
PortalInfo
Object.Equals(Object)
Object.Equals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Object.ReferenceEquals(Object, Object)
Object.ToString()
Namespace: Esri.ArcGISRuntime.Portal
Assembly: Esri.ArcGISRuntime.dll
Syntax
[DataContract]
public sealed class PortalInfo
Remarks

If the user is not logged in or if the logged user doesn't belong to an organization, these information concern the default view of the portal. If the user is logged in or if the Url is an organization custom Url, the information will be specific to the organization that the user belongs to. The default view of the portal is dependent on the culture of the user which is obtained from the users profile.

You may get the current portal info by the PortalInfo property.

Properties

Name Description
Access

Gets the level of access that anonymous users have to your organization.

AppInfo

Gets the information about the application through which this resource was accessed. This information is based on the token used to access this resource.

AuthorizedCrossOriginDomains

Gets the array of trusted servers that clients can send credentials to when making cross-origin resource sharing (CORS) requests to access web-tier secured services.

BasemapGalleryGroupQuery

Gets the query expression used to determine which group's basemaps are displayed.

BingKey

Gets the Bing key required for webmaps using Bing.

CanSearchPublic

Gets a value indicating whether members of the organization can search outside of the organization.

CanShareBingPublic

Gets a flag indicating whether the bing key can be shared to the public and will be returned as part of a PortalInfo description.

CanSharePublic

Gets a value indicating whether members of the organization can share resources outside of the organization.

Created

Gets the date the organization was created.

CultureInfo

Gets the organization default locale (language and country) information.

CustomBaseDomain

Gets the custom base URL for the organization.

DefaultBasemap

Gets the default basemap to be used when creating new maps.

DefaultExtent

Gets the default extent to be used when creating new maps.

DefaultVectorBasemap

Gets the default basemap to be used when creating new maps, and should be used instead of DefaultBasemap when UseVectorBasemaps is true.

DeveloperBasemapGalleryGroupQuery

Gets the query that identifies the group containing developer basemaps.

FeaturedGroupsQueries

Gets a collection of group query string.

FeaturedItemsGroupQuery

Gets the query expression used to determine which group's featured items are displayed.

HelperServices

Gets a class that provides access to various services. These include "GeocodeService", "GeometryService", "ClosestFacilityService", etc

HomePageFeaturedContentCount

Gets the number of items to show per page for the featured content screens (max=100).

HomePageFeaturedContentGroupQuery

Gets the query expression used to determine which group's featured content is displayed.

HostName

Gets the portal host's URL.

IPCountryCode

Gets the ISO Country Code of the client's IP address (online only - Not used in on premises Portal).

IsAllSSL

Gets a value indicating whether the access to the portal resources must occur over SSL.

IsCommentsEnabled

Gets a value indicating whether comments are enabled.

IsPortal

Gets a value indicating whether the portal is on premises.

IsReadOnly

Gets a value indicating whether the portal is currently in read-only mode.

LicenseInfo

Gets the license information for the currently logged-in PortalUser, this can return license information to enable additional ArcGIS Runtime capabilities. A null is returned if this is not the CurrentUser or there is no license information available.

LivingAtlasGroupQuery

Gets the query that identifies the group containing the Living Atlas layers to be displayed.

Modified

Gets the date the organization was last modified.

OrganizationBannerUri

Gets the URI of the thumbnail image for the organization.

OrganizationDescription

Gets the description of the organization. In the case of non-organizational users of ArcGIS Online or a multi-tenant portal, this will be null.

OrganizationId

Gets the id of the organization, if the user belongs to one.

OrganizationName

Gets the name of the organization. In the case of non-organizational users of ArcGIS Online or a multi-tenant portal, this will be null.

OrganizationSubdomain

Gets the portion of the URL's host component that identifies a specific organization subscription within a portal.

Portal

Gets the ArcGIS Portal associated with the PortalInfo.

PortalMode

Gets the portal mode (single-tenant or multi-tenant).

PortalName

Gets the name of the portal.

PortalThumbnailUri

Gets the URI of the portal thumbnail.

ReadOnlyMessage

Gets an explanatory message that can be displayed to the user if the portal is currently in read-only mode.

ShowHomePageDescription

Gets a value indicating whether to show the description of the organization on the home page.

StylesGroupQuery

Gets the query that identifies the group containing a variety of styles that contain references to symbology that can be used in the ArcGIS platform.

SubscriptionInfo

Gets information about the user's subscription.

SupportsOAuth

Gets a value indicating whether the portal supports OAuth.

SymbolSetsGroupQuery

Gets the query that identifies the symbol sets group.

ThumbnailUri

Gets the URI of the thumbnail image for the organization. In the case of non-organizational users of ArcGIS Online or a multi-tenant portal, this will be null.

UseVectorBasemaps

Gets a value indicating whether an organization should use the Esri vector basemaps in supported ArcGIS apps.

VectorBasemapGalleryGroupQuery

Gets the query expression used to determine which group's vector basemaps are displayed.

Methods

Name Description
GetOrganizationBannerDataAsync()

Get the organization banner image data.

GetOrganizationBannerDataAsync(CancellationToken)

Get the organization banner image data.

GetPortalThumbnailDataAsync()

Get the portal thumbnail image data.

GetPortalThumbnailDataAsync(CancellationToken)

Get the portal thumbnail image data.

GetThumbnailDataAsync()

Get the thumbnail image data.

GetThumbnailDataAsync(CancellationToken)

Get the thumbnail image data.

Applies to

TargetVersions
.NET Standard 2.0100.3 - 100.14
.NET 6.0100.13 - 100.14
.NET 6.0 Windows100.13 - 100.14
.NET Framework100.0 - 100.14
.NET 5100.10 - 100.12
.NET Core 3.1100.7 - 100.12
Xamarin.Android100.0 - 100.14
Xamarin.iOS100.0 - 100.14
UWP100.0 - 100.14
In This Article
Back to top Copyright © 2021 Esri.