downloadFile

Overview

my.downloadFile downloads a file from a remote server to a local location. The downloaded file path is returned in the success callback and can be used with other APIs like my.previewImage or my.openDocument.

Sample Code

my.downloadFile({
  url: 'http://img.example.com/example.jpg',
  success: ({ apFilePath }) => {
    my.previewImage({
      urls: [apFilePath],
    });
  },
  fail: (res) => {
    my.alert({
      content: res.errorMessage || res.error,
    });
  },
});

Parameters

Success Callback Function

The incoming parameter is of the Object type with the following attributes:

Error Code

Usage Notes

• The downloaded file is stored in a temporary location
• Use the returned apFilePath with APIs like my.previewImage, my.openDocument, or my.saveFile
• The file must be accessible via HTTP/HTTPS
• Custom headers can be set via the header parameter
• The temporary file may be cleaned up by the system, use my.saveFile to persist it

Related Links

• my.request - Network request
• my.saveFile - Save file locally
• my.openDocument - Open document
• my.previewImage - Preview image