Skip to content

Sharing Files in Android with other Apps in the Device

Generally, in Android, file sharing from one app with another app happens in the form of content URI. So, you need to make your app generate content URIs of files that you want to share with other apps.

To share a file from your app with other apps

  1. Specify the sharable directories in the XML file
  2. Specify the FileProvider in the Manifest Properties
  3. Create or copy the sharable files to the shared directory

Specifying the Sharable Directories in the XML file

Volt MX platform does not share any directory of an app by default due to security concerns. To share directories or files with other apps is under your control. So, to share files with other apps, you must explicitly specify sharable directories in your app. You can specify the shared directories using an XML file.

To specify the shared directories

  1. Create an XML file. For example, filepaths.xml.
  2. Place the XML file at the workspace/resources/mobile/native/android/xml subdirectory in your mobile app project directory.

Note: If your Android app is for tablet, place the file at the workspace/resources/tablet/native/android/xml subdirectory.

  1. In the XML file, add the <paths></paths>tag as parent element, and then add the directories of the files you want to share as child elements inside the parent element. You can specify multiple directories in the parent element. Below is a sample path defined in the XML file (filepaths.xml).


If you want to share multiple directories, below is a sample:


  1. Use any of the following child elements inside the <paths></paths> parent element to specify the directories that contain sharable files.

  2. : to specify the subdirectories within the files/ directory in your app’s internal storage. The directory is the same as the value returned by

For more information, see Specifying Available Files.

  1. Within the child element tags, you must specify the attribute, path to define the directory path where the sharable files are located. If you want to share files and directories in the root directory, specify the value of the pathattribute as "/". Otherwise, specify the subdirectory path. For example, "images/".

Note: Make sure that the subdirectories that you defined in the path attribute are already created at the root directory using the API.

  1. The name attribute indicates the path segment in the generated content URI for the files located in the shared directory. When multiple directories are shared, define the name attribute separately for each directory shared by the path element.

The name of the XML file (filepaths.xml) that you have created with the shared directories should be specified as the value to the attribute, android:resource in the FileProvider Manifest Properties.


In the example, replace the <filename> with the name of the XML file. For example, filepaths. Make sure that the extension, .xml is not specified along with the file name.

Specifying the FileProvider in the Manifest Properties

FileProvider is a mechanism provided by Android to generate content URIs of the files to be shared with other apps. The XML file with sharable directories is passed to the FileProvider for generating the content URI. Based on the specifications defined in the XML file, the FileProvider generates content URIs of file objects.

To specify the FileProvider in the Manifest

  1. Open the app, and click Project Settings. The Project Settings dialog opens.
  2. Click the Native tab, and then click Android sub-tab.
  3. Under the ManifestProperties, click the Tags tab.
  4. In the Application Tag Attributes box, copy and paste the following code snippet.

     android:resource="@xml/filepaths" />

In the code snippet, the values specified for the android:authorities and android:resource attributes are just examples. For the android:authorities attribute, you must replace the value with the package name of your Android app. For the android:resource attribute, you must replace only the filepaths string with the file name of the XML file.

Note: Ensure that you add the {implementation 'androidx.core:core:+'} in the build.gradle entries to Suffix field of the Project Settings > Native > Android Mobile/Tablet section.

Note: Make sure that the extension, .xml is not specified along with the file name of the XML file.

Creating Files in the Shared Directories

Create or copy files that you want to share in the shared directories.

To share the raw bytes returned from the Image Widget, voltmx.image.createImage, and voltmx.image.createImageFromSnapshot functions, save the raw bytes as files using the API in the shared directories. The file raw bytes returned by the API can be used for sharing with other apps.

Use Case: Attaching a File to an Email

When an end-user wants to attach a file from your app to an Email, you must invoke the function. When invoking the function from an Android app, the attachment parameter must be raw bytes. You can directly pass the raw bytes received from the (only public access mode) and APIs as the attachment parameter. Because, the raw bytes received from these sources already contain content URI.

To support raw bytes obtained from the following sources as an attachment in the API, you must follow the Sharing a File in Android with other Apps procedure.

Here is a sample code of passing an image file, which is converted into content URI, in the attachment parameter of the function.

var testImg = voltmx.image.createImageFromSnapShot(frmHome.Flxgrp);
frmHome.Img2.image = testImg;
var testRaw = testImg.getImageAsRawBytes();
var path;
var sharedDir = path+constants.FILE_PATH_SEPARATOR+"images";
var sharefolder = new;
var fileLoc = sharedDir+constants.FILE_PATH_SEPARATOR+"myimage.jpg";
var myfile=new;
var write=new;
var fileRawBytes=new;
var to = [""];
var cc = [""];
var bcc = [""];
var sub = "Testing Screenshot attachment";
var msgbody = "Testing openEmail with attachment";
var attachment = {mimetype: "image/*",attachment: fileRawBytes };, cc, bcc, sub, msgbody, false, [attachment]);