Show / Hide Table of Contents

Method SaveAsAsync

SaveAsAsync(ArcGISPortal, PortalFolder, String, String, IEnumerable<String>, RuntimeImage, Boolean)

Save the map to a new PortalItem.

Declaration
public Task<PortalItem> SaveAsAsync(ArcGISPortal portal, PortalFolder portalFolder, string title, string description, IEnumerable<string> tags, RuntimeImage thumbnailImage = null, bool forceSaveToSupportedVersion = false)
Parameters
Type Name Description
ArcGISPortal portal

The portal to save the map to

PortalFolder portalFolder

The portal folder in which to save the map. If null is passed it will be saved to the user's root folder.

String title

The title of the map. Cannot be empty

String description

The description of the map

IEnumerable<String> tags

The tags to be associated with the newly created portal item

RuntimeImage thumbnailImage

The thumbnail of the map

Boolean forceSaveToSupportedVersion

Flag to indicate whether the map should be saved to the supported webmap version that the API supports (see system requirements). This may cause data loss as unknown data is not saved. If true, unknown data will be removed and the map will be saved. If false, the operation will fail if the map contains unknown data that will not be saved. This flag can be used to provide a warning to users that some map data may be lost when the map is saved.

Returns
Type Description
Task<PortalItem>

The task object representing the asynchronous save as operation. The value of the task result is a PortalItem object.

Remarks

Asynchronous method to save a map as a new portal item. The map does not need to be associated with an existing PortalItem object. The map must be loaded. The result is a reference to the new PortalItem which the map is now associated with.

Note that if the map was already associated with a PortalItem object (either because the map was created using a PortalItem or was previously saved), that object will be replaced with a new PortalItem, effectively duplicating the map on the portal.

Exceptions
Type Condition
InvalidOperationException

Map must be loaded before saving to a portal.

Applies to

Platforms and versions
TargetVersions
.NET Standard 2.0100.3 - 200.0
.NET 6.0100.13 - 200.0
.NET 6.0 Windows100.13 - 200.0
.NET 6.0 iOS200
.NET Framework100.1 - 200.0
.NET 5100.10 - 100.12
.NET Core 3.1100.7 - 100.12
Android100.1 - 100.14
iOS100.1 - 100.15
UWP100.1 - 200.0

SaveAsAsync(ArcGISPortal, PortalFolder, String, String, IEnumerable<String>, RuntimeImage, Boolean, CancellationToken)

Save the map to a new PortalItem.

Declaration
public async Task<PortalItem> SaveAsAsync(ArcGISPortal portal, PortalFolder portalFolder, string title, string description, IEnumerable<string> tags, RuntimeImage thumbnailImage, bool forceSaveToSupportedVersion, CancellationToken cancellationToken)
Parameters
Type Name Description
ArcGISPortal portal

The portal to save the map to

PortalFolder portalFolder

The portal folder in which to save the map. If null is passed it will be saved to the user's root folder.

String title

The title of the map. Cannot be empty

String description

The description of the map

IEnumerable<String> tags

The tags to be associated with the newly created portal item

RuntimeImage thumbnailImage

The thumbnail of the map

Boolean forceSaveToSupportedVersion

Flag to indicate whether the map should be saved to the supported webmap version that the API supports (see system requirements). This may cause data loss as unknown data is not saved. If true, unknown data will be removed and the map will be saved. If false, the operation will fail if the map contains unknown data that will not be saved. This flag can be used to provide a warning to users that some map data may be lost when the map is saved.

CancellationToken cancellationToken

A CancellationToken with which to cancel the operation if required.

Returns
Type Description
Task<PortalItem>

The task object representing the asynchronous save as operation. The value of the task result is a PortalItem object.

Remarks

Asynchronous method to save a map as a new portal item allowing cancellation. The map does not need to be associated with an existing PortalItem object. The map must be loaded. The result is a reference to the new PortalItem which the map is now associated with.

Note that if the map was already associated with a PortalItem object (either because the map was created using a PortalItem or was previously saved), that object will be replaced with a new PortalItem, effectively duplicating the map on the portal.

Applies to

Platforms and versions
TargetVersions
.NET Standard 2.0100.3 - 200.0
.NET 6.0100.13 - 200.0
.NET 6.0 Windows100.13 - 200.0
.NET 6.0 iOS200
.NET Framework100.1 - 200.0
.NET 5100.10 - 100.12
.NET Core 3.1100.7 - 100.12
Android100.1 - 100.14
iOS100.1 - 100.15
UWP100.1 - 200.0
In This Article
Back to top Copyright © 2022 Esri.