download

Description

Initiates an asynchronous download of a specified Internet resource such as a file, raw data, or image.

When downloading completes, the results are stored inside the runtime's cache object using a provided key.

The Ux.ResourceReady event is also triggered so you can take action when your resource becomes available.

Downloading resources from an app's locker is also supported using the resource's locker token. This is the recommended approach for downloading resources since they are fully managed by the app.

Input Parameters

Returns

Type: Any

Returns the downloaded Internet resource and attempts to convert it to the type specified. Text is the default type.

The following types are supported:

Examples

// inside the Ux.Initialize script...
// initiate download of text resource from app's locker using its token
network.download("TOKEN", "config");

// inside the Ux.Initialize script...
// initiate download of text and json resources from the Internet
network.download("https://www.mydomain.com/file.txt", "config");
network.download("https://www.mydomain.com/object.json", "person", "json");

// inside the Ux.ResourceReady script...
// note: this script will run once for each downloaded resource

// get the cache key for this downloaded resource
var key = script.args[0];

// fetch the downloaded resource from cache
var item = cache.get(key);

Remarks

Use this function when you need to download external resources from the Internet such as files, raw data, or images.

Downloading resources from your app's locker instead of the open Internet is strongly recommended since they are fully managed by the app.

One common scenario is to download a file available on a server using the Ux.Initialize event. Once downloaded, you can take action using the Ux.ResourceReady event. The cache key you provided is accessible via the runtime's script object.