ItemPackage QML Type

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

Import Statement: import ArcGIS.AppFramework 1.0





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 code sample, derived from AppStudio Player, provides a button to download a given item package. Be aware that for this sample to function, 'portal' and 'itemId' needs to be defined elsewhere in your app.

Item {
        ItemPackage {
                id: itemPackage
                portal: app.portal

                onDownloadComplete: {
                        console.log("Itempackage downloaded")

                onDownloadError: {
                        messageDlg.text = error.message;
                        messageDlg.informativeText = error.details;

        MessageDialog {
                id: messageDlg
                title: "Download Error"
                icon: StandardIcon.Critical

        Button {
                text: "Download"
                onClicked: {


Status enumeration

Enum describing the current status of the download process.


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


Signal emitted when the download process has completed.

downloadError( AppFrameworkError error)

Signal emitted when the download process has encountered an error.

downloadProgress( int percentage, int secondsRemainingEstimate)

Signal emitted whenever the download progresses.


Signal emitted when the download process has started.

Method Documentation


Begins downloading the declared item.

The itemId parameter

The ID of the item to download.

bool exists(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.