Skip to main content

 

 

 

Template:OutSystems/Documentation_KB/Breadcrumb_New_Layout

 

 

Template:OutSystems/OSLanguageSwitcher

 

Applies only to Mobile Apps

 

 

OutSystems

File Transfer Plugin

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    Collaborate with us
    Edit this page on GitHub
  • File Transfer Plugin lets you download and upload files in your mobile app. The plugin provides advanced file transfer that runs in the background, and continues even when the user closes or suspends the app.

    File Transfer Plugin also has a progress update for transfers that take longer, for example video, music, and large images.

    To use the plugin, do the following:

    1. Install File Transfer Plugin from Forge to your environment.

    2. Add the plugin actions to the app. In Service Studio, go to Manage Dependencies (Ctrl+Q), search for FileTransferPlugin and select actions you want to use.

      Adding File Plugin to the app

      After you reference the File Plugin, you can use the actions and events to create your logic.

    Sample app

    Install File Sample App from Forge and open the app in Service Studio. The sample app contains logic for common use cases, which you can examine and recreate in your apps.

    Reference

    The File Transfer Plugin uses a Cordova plugin, and for more information check cordova-plugin-file-transfer.

    Actions

    Here is the reference for the actions you can use from the File Transfer Plugin, available in Logic > Client Actions > FileTransferPlugin.

    Action Description
    CheckFileTransferPlugin Checks if the device can upload and download files.
    DownloadFile Action to download files from the server.
    DownloadFileWithHeaders Action to download files from the server with HTTP headers.
    UploadFile Action to upload files to the server.
    UploadFileWithHeaders Action to upload files to the server with HTTP headers.

    Events

    Here is the reference for the events you can use from the File Transfer Plugin, available in UI Flows > FileTransferPlugin > FileTransfer.

    Event Block
    OnDownloadComplete HandleDownload
    OnDownloadError HandleDownload
    OnDownloadProgress HandleDownload
    OnUploadComplete HandleUpload
    OnUploadError HandleUpload
    OnUploadProgress HandleUpload
    • Was this article helpful?