SuperApp:Files

WVFile.write

Writes specified file content to disk.

Input parameters

• [string] mode: The file writing mode.

  • write: Writes to a file. If the file does not exist, it is created. If the file already exists, an error:FILE_EXIST error is returned.

  • append: Appends content to the end of a file. If the file does not exist, it is created.

  • overwrite: Overwrites a file. If the file does not exist, it is created. If the file exists, its content is overwritten.

• [string] data: The content to write to the file. The API saves the file to WindVane cache file path/fileName. If the path does not exist, the API automatically creates it.

• [string] fileName: The file name. A file is created if it does not exist. The file name cannot contain forward slashes (/).

• [string] share: Specifies whether the file can be shared.

Callback parameters

The success callback is invoked upon a successful write. Otherwise, the failure callback is invoked.

var params = {
        mode: 'overwrite',
        data: 'Hello World!!!\n',
        fileName: 'testFile.txt',
        share: 'false'
};
function writeFile () {
        window.WindVane.call('WVFile', 'write', params, function(e) {
                alert('success: ' + JSON.stringify(e));
        }, function(e) {
                alert('failure: ' + JSON.stringify(e));
        });
}

WVFile.read

Reads the content of a specified file.

Input parameters

• [string] fileName: The name of the file to read. The file name cannot contain forward slashes (/). The file must be located in the WindVane cache file path/fileName directory. If the path does not exist, an error:PATH_NOT_FOUND error is returned. If the file does not exist, an error:FILE_NOT_FOUND error is returned.

Callback parameters

The success callback is invoked upon a successful read. Otherwise, the failure callback is invoked.

• [string] data: The content read from the file.

var params = {
        fileName: 'testFile.txt',
        share: 'false'
};
function readFile () {
        window.WindVane.call('WVFile', 'read', params, function(e) {
                success(JSON.stringify(e));
        }, function(e) {
                failure(JSON.stringify(e));
        });
}

WVFile.getFileInfo

Gets file information.

Input parameters

• [string] filePath: The file path.

Callback parameters

Success callback parameters:

• [string] fileSize: The file size.

Failure callback parameters:

• [string] msg: The error message.

The success callback is invoked upon successful retrieval of the file information. Otherwise, the failure callback is invoked.

var params = {
        filePath: '/storage/emulated/0/Android/data/xxx/testFile.txt',
};
function readFile () {
        window.WindVane.call('WVFile', 'getFileInfo', params, function(e) {
                success(JSON.stringify(e));
        }, function(e) {
                failure(JSON.stringify(e));
        });
}

WVFile.downloadFile

Downloads a file from a specified URL.

Input parameters

• [string] url: The file download URL.

• [string] name: Optional. The local name for the downloaded file. The default value is "timestamp_windvane". We recommend that you specify a name for each download.

Callback parameters

Success callback parameters:

• [string] filePath: The local storage path of the downloaded file.

Failure callback parameters:

• [string] msg: The error message.

Event listeners

WVFile.Event.downloadFileSuccess

Triggered when a file is downloaded successfully.

Event parameters:

• [string] filePath: The local storage path of the downloaded file.

WVFile.Event.downloadFileFailed

Triggered when a file download fails.

• [string] msg: The error message.

document.addEventListener('WVFile.Event.downloadFileSuccess', function (e) {
        alert('event downloadFileSuccess: ' + JSON.stringify(e.param));
});
document.addEventListener('WVFile.Event.downloadFileFailed', function (e) {
        alert('event downloadFileFailed: ' + JSON.stringify(e.param));
});

var params = {
    url: 'http://example.com/test.mp4',
  	name: 'test.mp4'
};
window.WindVane.call('WVFile', 'downloadFile', params, function(e) {
        alert('downloadFile success: ' + JSON.stringify(e));
}, function(e) {
        alert('downloadFile failure: ' + JSON.stringify(e));
});

WVFile.uploadFile

Uploads a file to a specified server URL.

Input parameters

• [string] url: The URL to which the file will be uploaded.

• [string] filePath: The local storage path of the file to upload. Your application must have read permissions for the file at this path. The upload will not start if permission is not granted.

• [int] timeout: Optional. The timeout in milliseconds. The default value is 6000.

• [object] headers: Optional. The headers to include in the upload request.

Callback parameters

Success callback parameters:

• [string] data: The data returned by the server upon a successful upload.

• [string] headers: The headers returned by the server upon a successful upload.

Failure callback parameters:

• [string] msg: An error message. If an error occurs during the upload, msg is a JSON string that contains the following fields:

  • [int] code: The HTTP status code.

  • [string] data: The data returned by the server.

  • [string] headers: The headers returned by the server.

Event listeners

WVFile.Event.uploadFileSuccess

Triggered when a file is uploaded successfully.

Event parameters:

• [string] data: The data returned by the server upon a successful upload.

• [string] headers: The headers returned by the server upon a successful upload.

WVFile.Event.uploadFileFailed

Triggered when a file upload fails.

• [string] msg: An error message. If an error occurs during the upload, msg is a JSON string that contains the following fields:

  • [int] code: The HTTP status code.

  • [string] data: The data returned by the server.

  • [string] headers: The headers returned by the server.

document.addEventListener('WVFile.Event.uploadFileSuccess', function (e) {
        alert('event uploadFileSuccess: ' + JSON.stringify(e.param));
});
document.addEventListener('WVFile.Event.uploadFileFailed', function (e) {
        alert('event uploadFileFailed: ' + JSON.stringify(e.param));
});

var params = {
    url: 'http://example.com/upload',
  	filePath: '/storage/test.txt',
    timeout: 8000,
    headers: {
       key: 'value'
    }
};
window.WindVane.call('WVFile', 'uploadFile', params, function(e) {
        alert('uploadFile success: ' + JSON.stringify(e));
}, function(e) {
        alert('uploadFile failure: ' + JSON.stringify(e));
});

WVFile.chooseFiles

Allows you to select local files.

Input parameters

Callback parameters

Success callback parameters:

The success callback receives an object with the following parameter:

The files array contains objects, each with the following property:

Failure callback parameters:

Example:

window.WindVane.call(
  'WVFile',
  'chooseFiles',
  {},
  function(response) {
    const files = response.files;
    alert("open success: " + JSON.stringify(files));  
  }, function(e) {
    alert("open fail: " + JSON.stringify(e));
  }
);

WVFile.getDataByFilePath

Gets local file data.

Input parameters

Callback parameters

Success callback parameters:

Failure callback parameters:

Example:

window.WindVane.call('WVFile', 'getDataByFilePath', { path: '/download/dingding/0/1.png' }, function(data) {
    const base64Data = data.base64Data;
    alert('getDataByFilePath success: ' + JSON.stringify(data.base64Data));
    // Implement your logic to send the data to your backend server to save the file.
    ...
    ...

}, function(error) {
    alert('getDataByFilePath failure: ' + JSON.stringify(error));
});