Obsolete Members for PortalUser

PortalUser

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

Public Functions

Signals

Member Function Documentation

[signal, since Esri::ArcGISRuntime 100.1] void PortalUser::addPortalItemCompleted(bool success)

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

Signal emitted when an add operation is completed. success is true when the operation succeeded.

This function was introduced in Esri::ArcGISRuntime 100.1.

[since Esri::ArcGISRuntime 100.1] void PortalUser::addPortalItemWithJson(Esri::ArcGISRuntime::PortalItem *portalItem, const QString &json, const Esri::ArcGISRuntime::PortalFolder &toFolder = PortalFolder())

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

Adds a PortalItem from a JSON object.

The portalItem will be created using the following arguments:

• portalItem. The local PortalItem which will be added to the portal.
• json. The JSON representation of the portal item. This format is particularly suitable for adding items such as web maps and is the format used by the Map::saveAsAsync method.
• toFolder (optional). The folder in which the item will be located. If empty, the item will be placed in the user's root folder.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also Items and item types.

[since Esri::ArcGISRuntime 100.1] void PortalUser::addPortalItemWithUrl(Esri::ArcGISRuntime::PortalItem *portalItem, const QUrl &fromUrl, const QString &fileName = QString(), const Esri::ArcGISRuntime::PortalFolder &toFolder = PortalFolder())

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

Adds a PortalItem from a local or online URL.

The PortalItem will be created using the following arguments:

• portalItem. The local PortalItem which will be added to the portal.
• fromUrl. The local or online URL from which the portalItem will be populated. For local files, this should be of the form "qrc:/example.csv" or "file://"; for online resources this should be of the form "https://...".
• fileName (optional). The name of the file which will be associated with the PortalItem (including extension). If a file name is not supplied, the portal item will have no file associated with it for future downloads.

  Note: A file name is only relevant for certain item types such as PortalItemType.Image.

• toFolder (optional). The folder in whih the item will be located. If empty, the item will be placed in the user's root folder.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also Items and item types.

void PortalUser::addToFavorites(Esri::ArcGISRuntime::PortalItem *portalItem)

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

Adds the PortalItem portalItem to the user's favorites group.

[signal] void PortalUser::addToFavoritesCompleted(bool success)

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

Signal emitted when a addToFavorites operation is completed.

The parameter success is true when the operation succeeded, otherwise false.

void PortalUser::createFolder(const QString &title)

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

Creates a new PortalFolder with the given title in the user's root folder.

Multilevel folders are not supported in a portal.

[signal, since Esri::ArcGISRuntime 100.1] void PortalUser::createFolderCompleted(bool success, const Esri::ArcGISRuntime::PortalFolder &folder)

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

Signal emitted when a createFolder operation is completed.

• success - Whether fetching content completed successfully.
• folder - The newly created PortalFolder.

This function was introduced in Esri::ArcGISRuntime 100.1.

void PortalUser::deleteFolder(const Esri::ArcGISRuntime::PortalFolder &folder)

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

Removes the specified folder from the portal.

[signal] void PortalUser::deleteFolderCompleted(bool success)

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

Signal emitted when a deleteFolder operation is completed. success is true when the operation succeeded.

void PortalUser::deletePortalItem(Esri::ArcGISRuntime::PortalItem *portalItem)

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

Removes the PortalItem portalItem from the portal.

[signal] void PortalUser::deletePortalItemCompleted(bool success)

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

Signal emitted when a delete item operation is completed. success is true when the operation succeeded.

void PortalUser::fetchContent()

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

Starts an operation that fetches the user's content at the root level (not in a folder).

The content is made up of lists of PortalItem and PortalFolder objects.

Example:

Retrieve the model representing a user's folders:

// fetch the portal user's folders
QMap<QString, QString> folderTitles; // folderId and folderTitle

connect(&portalUser, &PortalUser::fetchContentCompleted, this, [&portalUser, &folderTitles](bool success)
{
  if(!success)
    return;

  PortalFolderListModel* folders = portalUser.folders();
  Q_CHECK_PTR(folders);

  for (int i = 0; i < folders->size(); ++i)
  {
    PortalFolder folder = folders->at(i);
    folderTitles[folder.folderId()] = folder.title();
    qDebug() << folder.title();
  }
});

portalUser.fetchContent();

[signal, since Esri::ArcGISRuntime 100.1] void PortalUser::fetchContentCompleted(bool success)

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

Signal emitted when the fetchContent or fetchContentInFolder operations are completed.

• success - Whether fetching content completed successfully.

This function was introduced in Esri::ArcGISRuntime 100.1.

void PortalUser::fetchContentInFolder(const QString &folderId)

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

Starts an operation that fetches the user's content within a specific folder (folderId).

The content is made up of lists of PortalItem objects.

void PortalUser::fetchFavoritesStatus(Esri::ArcGISRuntime::PortalItem *portalItem)

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

Starts an operation to determine whether PortalItem portalItem is in the user's favorites group.

The fetchFavoritesStatusCompleted is emitted when the operation is complete.

[signal] void PortalUser::fetchFavoritesStatusCompleted(bool status)

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

Signal emitted when a removeFromFavorites operation is completed. status is true when the operation succeeded.

void PortalUser::movePortalItem(Esri::ArcGISRuntime::PortalItem *portalItem, const Esri::ArcGISRuntime::PortalFolder &toFolder = PortalFolder())

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

Moves a PortalItem.

Move item portalItem to the folder specified by toFolder. Leaving toFolder empty will move the item to the user's root folder.

[signal] void PortalUser::movePortalItemCompleted(bool success)

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

Signal emitted when a move item operation is completed. success is true when the operation succeeded.

[since Esri::ArcGISRuntime 100.1] void PortalUser::movePortalItems(const QList<Esri::ArcGISRuntime::PortalItem *> &portalItems, const Esri::ArcGISRuntime::PortalFolder &toFolder = PortalFolder())

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

Moves multiple PortalItems.

Move the items listed in portalItems to the folder specified by toFolder. Leaving toFolder empty will move the items to the user's root folder.

This function was introduced in Esri::ArcGISRuntime 100.1.

[signal] void PortalUser::movePortalItemsCompleted(const QList<Esri::ArcGISRuntime::PortalResult> &results)

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

Signal emitted when a movePortalItems operation is completed. The list of results indicates the status for individual items.

void PortalUser::removeFromFavorites(Esri::ArcGISRuntime::PortalItem *portalItem)

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

Removes the PortalItem portalItem from the user's favorites group.

[signal] void PortalUser::removeFromFavoritesCompleted(bool success)

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

Signal emitted when a removeFromFavorites operation is completed.

The parameter success is true when the operation succeeded, otherwise false.