Skip to content

Latest commit

 

History

History
53 lines (45 loc) · 2.28 KB

README.md

File metadata and controls

53 lines (45 loc) · 2.28 KB
Raw

Cordova/Phonegap

Android SDcard & External Storage access API

This is a sample API of using cordova-plugin-files to scan sdcard & external-storage in Android

Example of using the API:

new ExternalStorageSdcardAccess( fileHandler ).scanPath( "file:///storage/sdcard1/music" );
function fileHandler( fileEntry ) {
    console.log( fileEntry.name + " | " + fileEntry.toURL() );
}

Preparation:

<script src="js/exernalStorageSdcardAccess.js"></script>
  • config.xml
delete: <preference name="AndroidExtraFilesystems"/>
  • make sure testing environment can access it's own external storage at the time of testing. ( e.p. if the device is connected with usb, make sure it is connected as a camera; Call the APIs after recieving the "deviceready" event )

APIs

ExternalStorageSdcardAccess( _fileHandler, _errorHandler ):
Create a new instance of this class to use the API.Both parameters have default handler.
@params _fileHandler(fileEntry): when a file is discovered, the handler will be called, pass a FileEntry object
@params _errorHandler(error): when a error occurs, the handler will be called, pass a FileError object

ExternalStorageSdcardAccess.scanRoot:
Scan all the files by using all the pathes in the array

ExternalStorageSdcardAccess.scanPathList( arrayOfPath ):
Scan all the files and directories from the root

ExternalStorageSdcardAccess.scanPath( path ):
Scan all the files by using the path

Things need to know before looking into the source code

DirectoryEntry: https://cordova.apache.org/docs/en/2.4.0/cordova/file/directoryentry/directoryentry.html
FileEntry: http://docs.phonegap.com/en/edge/cordova_file_file.md.html#FileEntry

About correct path parameter

"cdvfile://localhost/",                 // * Err 5 (wrong pattern)
"file:///",                             // * root, directoryEntry
"file:///somefile/",                    // * somefile, directoryEntry
"file:///somefile",                     // * somefile, directoryEntry
"file:///randomdumbname",               // * Err 1, (not found)
"file:///somefile/ACG/aaaaa.mp3",       // * OK, fileEntry