Obsolete Members for Portal

Portal

The following members of class Portal are deprecated. They are provided to keep old source code working. We strongly advise against using them in new code.

Public Functions

Member Function Documentation

void Portal::fetchBasemaps()

This function is deprecated. We strongly advise against using it in new code.

Retrieves the portal's basemaps using the PortalInfo::basemapGalleryGroupQuery query string.

The result is a read-only collection of Basemap objects. The basemaps are not loaded, but their PortalItem metadata are available using Basemap::item.

Example:

Fetch the basemaps for a portal:

int basemapsCount = 0;
connect(portal, &Portal::basemapsChanged, this, [portal, &basemapsCount]()
{
  if (portal && portal->basemaps())
    basemapsCount = portal->basemaps()->rowCount();
});

portal->fetchBasemaps();

See also Basemap, Portal::basemaps, and PortalInfo::basemapGalleryGroupQuery.

[since Esri::ArcGISRuntime 100.12] void Portal::fetchDeveloperBasemaps()

This function is deprecated. We strongly advise against using it in new code.

Retrieves the portal's developer basemaps using the PortalInfo::developerBasemapGalleryGroupQuery query string.

A Portal instance may contain a set of associated basemaps, called developer basemaps, which are accessible and metered via API keys. These are equivalent to basemaps constructed via a BasemapStyle.

This function was introduced in Esri::ArcGISRuntime 100.12.

See also Basemap, Portal::developerBasemaps, and PortalInfo::developerBasemapGalleryGroupQuery.

void Portal::fetchFeaturedGroups()

This function is deprecated. We strongly advise against using it in new code.

Retrieves the featured groups for the organization.

The result is an unmodifiable list of PortalGroup objects. These are fully populated and have a load status of LoadStatus::Loaded.

See also PortalGroup.

void Portal::fetchFeaturedItems()

This function is deprecated. We strongly advise against using it in new code.

Retrieves the set of featured items available from the portal.

After the items have been retrieved, the results are available via the featuredItems method.

See also PortalItem.

void Portal::fetchHomepageFeaturedContent()

This function is deprecated. We strongly advise against using it in new code.

Retrieves the set of items featured on the homepage of the portal.

After the content has been retrieved, the results are available via the homepageFeaturedContent method.

See also PortalItem.

[since Esri::ArcGISRuntime 200.4] QFuture<void> Portal::fetchHomepageFeaturedContentAsync()

This function is deprecated. We strongly advise against using it in new code.

Retrieves the set of items featured on the homepage of the portal using the PortalInfo::homePageFeaturedContentGroupQuery query string.

The operation is complete when the QFuture is finished.

After the content has been retrieved, the results are available via the homepageFeaturedContent method.

since Esri::ArcGISRuntime 200.4

This method uses the legacy home page which has been phased out of use in the ArcGIS Online home app. All legacy home pages are no longer live on ArcGIS Online and at a future release of ArcGIS Enterprise this method will no longer be supported.

Canceling the QFuture will not stop this operation from completing, though the QFuture will report that it is canceled and the completion handler will not be called.

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.4.

See also PortalItem.

[since Esri::ArcGISRuntime 100.7] Esri::ArcGISRuntime::TaskWatcher Portal::fetchLicenseInfo()

This function is deprecated. We strongly advise against using it in new code.

Executes a portal query that gets the current user's LicenseInfo including the entitlements and extensions.

The fetchLicenseInfoCompleted signal will emit once the operation is complete, giving access to the resulting LicenseInfo.

This function was introduced in Esri::ArcGISRuntime 100.7.

[since Esri::ArcGISRuntime 100.12] void Portal::fetchStyles()

This function is deprecated. We strongly advise against using it in new code.

Retrieves a collection of styles using the PortalInfo::stylesGroupQuery query string.

The result is an unmodifiable list of PortalItem objects. Note: the collection size is limited to 25.

This function was introduced in Esri::ArcGISRuntime 100.12.

[since Esri::ArcGISRuntime 100.12] void Portal::fetchSymbolSets()

This function is deprecated. We strongly advise against using it in new code.

Retrieves a collection of symbol sets using the PortalInfo::symbolSetsGroupQuery query string.

The result is an unmodifiable list of PortalItem objects. Note: the collection size is limited to 25.

This function was introduced in Esri::ArcGISRuntime 100.12.

void Portal::findGroups(const Esri::ArcGISRuntime::PortalQueryParametersForGroups &queryParameters)

This function is deprecated. We strongly advise against using it in new code.

Finds the portal groups that match the given query parameters.

• queryParameters - the query parameters.

This method obtains a PortalQueryResultSetForGroups object containing a collection of PortalGroup objects. The PortalGroup objects are fully populated and have a load status of LoadStatus::Loaded. Use the PortalQueryParameters to restrict the items returned by this method. If you provide a simple keyword string for the search, such as "federal", this method searches the default set of high performance index fields, such as id, title, description, snippet, tags, and owner.

For more advanced searches, you can preface your simple keyword strings with ArcGIS Portal Directory REST named fields followed by a colon (:). These advanced searches can take advantage of Boolean operators (AND, NOT, OR, -) and a range of special characters. For a more information, see the Search reference document in the ArcGIS Portal Directory REST API. Here are some examples of advanced search strings:

To find one specific portal group by it's Id: "id:1db70a32f5f84ea9a88f5f460f22557b" To find all private portal groups with the word 'federal' in the Title field: "title:federal AND access:private" To find all portal groups with the word 'federal' in the Title field and the word 'restricted' in the Description field: "title:federal AND description:restricted" To find all portal groups with the word 'state' in the Title field and not have the word 'restricted' in the Description field: "title:state NOT description:restricted".

Example:

Use findGroups to retrieve all of the groups for a portal:

// example query to return all groups
QString groupsQuery = "1==1";
PortalQueryParametersForGroups findGroupsQueryParameters(groupsQuery);
portal->findGroups(findGroupsQueryParameters);

int numberOfGroups = 0;
connect(portal, &Portal::findGroupsCompleted, this, [&numberOfGroups](PortalQueryResultSetForGroups* results)
{
  if (results)
    numberOfGroups = results->totalResults();
});

See also PortalQueryParametersForGroups.

void Portal::findItems(const Esri::ArcGISRuntime::PortalQueryParametersForItems &queryParameters)

This function is deprecated. We strongly advise against using it in new code.

Finds portal items that match the specified query parameters.

• queryParameters - the query parameters.

This method obtains a PortalQueryResultSetForItems object that contains PortalItem objects. Since portal items can be maps, layers, applications or tools, use the PortalQueryParameters to restrict which items are returned. If you provide a simple keyword string for the search, such as "florida", this method searches a default set of high performance index fields, such as title, tags, snippet, description, type, and typekeywords.

For more advanced searches, you can preface your simple keyword strings with ArcGIS Portal Directory REST named fields followed by a colon (:). These advanced searches can take advantage of Boolean operators (AND, NOT, OR, -) and a range of special characters. For a more information, see the Search reference document in the ArcGIS Portal Directory REST API. Here are some examples of advanced search strings:

• To find one specific portal item by its Id: "id:00e5e70929e14055ab686df16c842ec1"
• To find all WebMap portal items with the word 'florida' in the Title field: "title:florida AND type:web map"
• To find all Layer Package portal items with the word 'florida' in the Title field: "title:florida AND type:layer package"
• To find all portal items with the word 'florida' in the Title field and the word 'esri' in the LicenseInfo field: "title:florida AND licenseinfo:esri"
• To find all portal items with the word 'florida' in the Title field and not have the word 'esri' in the LicenseInfo field: "title:florida NOT licenseinfo:esri"
• To find all portal items with located within a specific spatial extent and the word 'esri' in the LicenseInfo: "extent:[-114.3458, 21.7518] - [-73.125, 44.0658] AND licenseinfo:esri"
• To find all portal items with a SpatialReference.WKID of 4267: "spatialreference:4267"
• To find all portal items with a SpatialReference.WKID of 4267 or have the word 'cancer' in the Title field: "spatialreference:4267 OR title:cancer"

See also PortalQueryParametersForItems.

Esri::ArcGISRuntime::PortalItemListModel *Portal::homepageFeaturedContent() const

This function is deprecated. We strongly advise against using it in new code.

Returns the list of items featured on the homepage of the portal.

since Esri::ArcGISRuntime 200.4

This property uses the legacy home page which has been phased out of use in the ArcGIS Online home app. All legacy home pages are no longer live on ArcGIS Online and at a future release of ArcGIS Enterprise this property will no longer be supported.