ItemPackage QML Type

The ItemPackage component provides Access to Item Package related information and status. More...

Import Statement: import ArcGIS.AppFramework 1.0
Inherits:

AppFrameworkObject

Properties

Signals

Methods

Detailed Description

The ItemPackage component is used specifically for downloading item packages, either from ArcGIS Online or Portal for ArcGIS. It handles the location and ID of the package to download, as well as various signals to describe the downloads progress.

This component is deprecated at version 5.0. See the NetworkRequest component for how to download an item package.

Enumerations

Status enumeration

Enum describing the current status of the download process.

NameValue
ItemPackage.Null0
ItemPackage.Ready1
ItemPackage.Downloading2
ItemPackage.Error3

Property Documentation

itemId : string

Holds the item ID of the Portal item being downloaded.


portal : object

The object defining the portal being used to access the item.


[read-only] status : Status

Returns the current status of the download process, as described by the Status enum.


Signal Documentation

downloadComplete()

Signal emitted when the download process has completed.

Note: The corresponding handler is onDownloadComplete.


downloadError(AppFrameworkError error)

Signal emitted when the download process has encountered an error.

Note: The corresponding handler is onDownloadError.


downloadProgress(int percentage, int secondsRemainingEstimate)

Signal emitted whenever the download progresses.

Note: The corresponding handler is onDownloadProgress.


downloadStarted()

Signal emitted when the download process has started.

Note: The corresponding handler is onDownloadStarted.


Method Documentation

download(string itemId)

Begins downloading the declared item.

The itemId parameter

The ID of the item to download.


bool exists(string itemId)

Checks whether the item described by the given item ID exists, returning true or false as appropriate.

The itemId parameter

The item ID to check the presence of.


Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.