PortalInfo Class

Member Function Documentation

[override virtual noexcept] PortalInfo::~PortalInfo()

Destructor.

Esri::ArcGISRuntime::PortalAccess PortalInfo::access() const

Determines and returns true who can view the organization's content as an anonymous user.

If the portal access value is PortalAccess::Public, anonymous users can access the organization's content. If the value is PortalAccess::Private, only members of your organization can access the content.

[since Esri::ArcGISRuntime 200.7] QString PortalInfo::basemap3DGalleryGroupQuery() const

Returns a query that identifies the group that contains the 3D basemaps of the portal's 3D basemap gallery.

This gallery group is defined by the portal's administrator and contains the 3D basemaps that are displayed in the Scene Viewer basemap gallery. To explore the 3D basemap gallery PortalGroup, create a PortalQueryParameters using this query string, and call Portal::findGroupsAsync().

Portal::fetch3DBasemapsAsync uses this string to return a collection of basemaps from the portal's 3D basemap gallery.

This function was introduced in Esri::ArcGISRuntime 200.7.

See also Portal::fetch3DBasemapsAsync.

QString PortalInfo::basemapGalleryGroupQuery() const

Returns a query that identifies the group that contains the basemaps of the portal's basemap gallery.

This gallery group is defined by the portal's administrator and contains the basemaps that are displayed in the Map Viewer basemap gallery if a user logs in with an ArcGIS Online or ArcGIS Enterprise account.

To explore the basemap gallery PortalGroup, create a PortalQueryParameters using this query string, and call Portal::findGroupsAsync().

Portal::fetchBasemapsAsync uses this string to return a collection of basemaps from the portal's basemap gallery.

See also Portal::fetchBasemapsAsync.

QDateTime PortalInfo::created() const

Returns the date the organization was created.

QString PortalInfo::culture() const

Returns the organization's locale information, such as en_us.

[since Esri::ArcGISRuntime 200.0] QString PortalInfo::currentVersion() const

Returns the portal's current version number.

This function was introduced in Esri::ArcGISRuntime 200.0.

QUrl PortalInfo::customBaseDomainUrl() const

Returns the portion of the URL host component that identifies the portal.

This is the portion of the host component of the URL that identifies a specific organization subscription within the portal.

For example, http://organizationSubdomain/customBaseDomain/

[since Esri::ArcGISRuntime 200.7] QString PortalInfo::default3DBasemapQuery() const

Returns the query string that identifies the default 3D basemap.

This expression can be used as the query string parameter to find the default 3D basemap of the Portal. The default 3D basemap is the 3D basemap that is used when no basemap is specified.

This function was introduced in Esri::ArcGISRuntime 200.7.

Esri::ArcGISRuntime::Basemap *PortalInfo::defaultBasemap() const

Returns the default basemap of the portal/organization.

Esri::ArcGISRuntime::Envelope PortalInfo::defaultExtent() const

Returns the default extent for the basemaps.

[since Esri::ArcGISRuntime 100.12] QString PortalInfo::developerBasemapGalleryGroupQuery() const

Returns a query that identifies the group that contains the developer basemaps of the portal's developer basemap gallery.

This gallery group is defined by the portal's administrator and contains the developer basemaps that are displayed in the Map Viewer basemap gallery if a user logs in with an ArcGIS Location Platform account. To explore the developer basemap gallery PortalGroup, create a PortalQueryParameters using this query string, and call Portal::findGroupsAsync().

Portal::fetchDeveloperBasemapsAsync uses this string to return a collection of basemaps from the portal's developer basemap gallery.

This function was introduced in Esri::ArcGISRuntime 100.12.

See also Portal::fetchDeveloperBasemaps.

[since Esri::ArcGISRuntime 200.0] bool PortalInfo::eueiEnabled() const

Returns true if the organization allows ArcGIS Online to collect usage information from its members to improve the user experience, false otherwise.

This function was introduced in Esri::ArcGISRuntime 200.0.

QStringList PortalInfo::featuredGroupsQueries() const

Returns a QStringList of pre-defined query strings for finding featured groups.

Each string specifies the title and owner of a group and sometimes also the ID of the group.

QString PortalInfo::featuredItemsGroupQuery() const

Returns a pre-defined query string for finding the featured items group.

[static] Esri::ArcGISRuntime::PortalInfo *PortalInfo::fromJson(const QString &json, QObject *parent = nullptr)

Creates a new PortalInfo from json with an optional parent.

See also JsonSerializable.

Esri::ArcGISRuntime::PortalHelperServices *PortalInfo::helperServices() const

Returns various services provided by the organization.

See Portal Self (ArcGIS REST API) for a list of helper services.

QString PortalInfo::ipCountryCode() const

Returns the country code of the calling IP (ArcGIS Online only).

bool PortalInfo::isAllSsl() const

Returns a bool that determines whether the organization is using SSL.

If true, all calls made against resources that belong to the organization will require SSL.

bool PortalInfo::isCanSearchPublic() const

Returns true if the members of the organization can search content outside of the organization, false otherwise.

When false, no public items outside of the organization are included in searches. However, public items that are part of the organization are returned.

bool PortalInfo::isCanSharePublic() const

Returns true if the members of the organization can share content outside of the organization, false otherwise.

false indicates that content cannot be shared with everyone.

bool PortalInfo::isCommentsEnabled() const

Returns a bool that determines whether comments are enabled for the organization.

bool PortalInfo::isPortal() const

Returns true if the portal is on-premises, false otherwise.

[since Esri::ArcGISRuntime 100.9] bool PortalInfo::isReadOnly() const

Returns true if the portal is currently in read-only mode, false otherwise.

This function was introduced in Esri::ArcGISRuntime 100.9.

See also PortalInfo::readOnlyMessage.

bool PortalInfo::isSupportsOAuth() const

Returns true if the portal supports OAuth authentication, false otherwise.

[since Esri::ArcGISRuntime 100.13] QString PortalInfo::livingAtlasGroupQuery() const

Returns the query that identifies the group containing the Living Atlas layers.

This expression should be used as the query string parameter to find the group.

{Portal::findGroupsAsync(const Esri::ArcGISRuntime::PortalQueryParameters&, QObject*)}, {Esri::ArcGISRuntime::PortalQueryParameters} {PortalQueryParameters}

This function was introduced in Esri::ArcGISRuntime 100.13.

See also Esri::ArcGISRuntime::Portal::findGroupsAsync().

QDateTime PortalInfo::modified() const

Returns the date the organization was last modified.

QUrl PortalInfo::organizationBannerUrl() const

Returns the URL of the banner image of the organization.

QString PortalInfo::organizationDescription() const

Returns the description of the organization.

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

QString PortalInfo::organizationId() const

Returns the ID of the organization.

QString PortalInfo::organizationName() const

Returns the name of the organization.

In the case of non-organizational users of ArcGIS Online or a multi-tenant portal this will be empty.

QString PortalInfo::organizationSubdomain() const

Returns the portion of the URL host component that identifies a specific organization subscription within a portal.

For example, http://organizationSubdomain/customBaseDomain/.

Esri::ArcGISRuntime::Portal *PortalInfo::portal() const

Returns the portal being referred to.

[since Esri::ArcGISRuntime 200.0] QString PortalInfo::portalHostname() const

Returns the portal's hostname.

This function was introduced in Esri::ArcGISRuntime 200.0.

Esri::ArcGISRuntime::PortalMode PortalInfo::portalMode() const

Returns whether the portal is single or multi tenant.

A multi-tenant portal supports organization subscriptions, but a single-tenant does not.

QString PortalInfo::portalName() const

Returns the name of the portal.

QUrl PortalInfo::portalThumbnailUrl() const

Returns a URL to the portal's thumbnail.

[since Esri::ArcGISRuntime 100.9] QString PortalInfo::readOnlyMessage() const

Returns a bool that determines if the portal is currently in read-only mode, this is an explanatory message that can be displayed to the user.

This will be empty if PortalInfo::isReadOnly is false.

This function was introduced in Esri::ArcGISRuntime 100.9.

[since Esri::ArcGISRuntime 100.12] QString PortalInfo::stylesGroupQuery() const

Returns a query that identifies a group of styles. Each style contains references to symbols that can be used across ArcGIS products.

This expression can be used as the query string parameter to find the styles group. Instead of providing your own query, you can use the helper method Portal::fetchStyles to fetch the items in the styles group.

{Portal::findGroupsAsync(const Esri::ArcGISRuntime::PortalQueryParameters&, QObject*)}, {Esri::ArcGISRuntime::PortalQueryParameters} {PortalQueryParameters}

This function was introduced in Esri::ArcGISRuntime 100.12.

See also Esri::ArcGISRuntime::Portal::findGroupsAsync().

[since Esri::ArcGISRuntime 100.9] Esri::ArcGISRuntime::SubscriptionInfo *PortalInfo::subscriptionInfo() const

Returns the information about the portal user's subscription.

nullptr if the portal is accessed anonymously.

This function was introduced in Esri::ArcGISRuntime 100.9.

[since Esri::ArcGISRuntime 100.12] QString PortalInfo::symbolSetsGroupQuery() const

Returns a query that identifies the symbol sets group.

This expression can be used as the query string parameter to find the symbol sets group. Instead of providing your own query, you can use the helper method Portal::fetchSymbolSets to fetch the items in the symbol sets group.

{Portal::findGroupsAsync(const Esri::ArcGISRuntime::PortalQueryParameters&, QObject*)}, {Esri::ArcGISRuntime::PortalQueryParameters} {PortalQueryParameters}

This function was introduced in Esri::ArcGISRuntime 100.12.

See also Esri::ArcGISRuntime::Portal::findGroupsAsync().

QUrl PortalInfo::thumbnailUrl() const

Returns a URL to the organization's thumbnail.

[override virtual] QString PortalInfo::toJson() const

Reimplements: JsonSerializable::toJson() const.

Returns the PortalInfo as a JSON string representation.

See also JsonSerializable.

[since Esri::ArcGISRuntime 200.7] bool PortalInfo::use3DBasemaps() const

Returns true if the organization uses 3D basemaps in supported ArcGIS apps, false otherwise.

This function was introduced in Esri::ArcGISRuntime 200.7.

[since Esri::ArcGISRuntime 200.7] bool PortalInfo::useDefault3DBasemap() const

Returns true if the organization uses the default 3D basemap in supported ArcGIS apps, false otherwise.

This function was introduced in Esri::ArcGISRuntime 200.7.