content api the content api provides functionality to discover content such as images, videos, music, or others it is possible to search for specific content using filters the api also supports setting the attributes of specific content for more information on the content features, see stored content management guide playlist functionality has been added in tizen 2 3 since 2 0 summary of interfaces and methods interface method contentmanagerobject contentmanager void update content content void updatebatch content[] contents, optional successcallback? successcallback, optional errorcallback? errorcallback void getdirectories contentdirectoryarraysuccesscallback successcallback, optional errorcallback? errorcallback void find contentarraysuccesscallback successcallback, optional errorcallback? errorcallback, optional contentdirectoryid? directoryid, optional abstractfilter? filter, optional sortmode? sortmode, optional unsigned long? count, optional unsigned long? offset void scanfile domstring contenturi, optional contentscansuccesscallback? successcallback, optional errorcallback? errorcallback void scandirectory domstring contentdiruri, boolean recursive, optional contentscansuccesscallback? successcallback, optional errorcallback? errorcallback void cancelscandirectory domstring contentdiruri long addchangelistener contentchangecallback changecallback void removechangelistener long listenerid void getplaylists playlistarraysuccesscallback successcallback, optional errorcallback? errorcallback void createplaylist domstring name, playlistsuccesscallback successcallback, optional errorcallback? errorcallback, optional playlist? sourceplaylist void removeplaylist playlistid id, optional successcallback? successcallback, optional errorcallback? errorcallback void createthumbnail content content, thumbnailsuccesscallback successcallback, optional errorcallback? errorcallback contentarraysuccesscallback void onsuccess content[] contents contentdirectoryarraysuccesscallback void onsuccess contentdirectory[] directories contentscansuccesscallback void onsuccess domstring uri contentchangecallback void oncontentadded content content void oncontentupdated content content void oncontentremoved contentid id void oncontentdiradded contentdirectory contentdir void oncontentdirupdated contentdirectory contentdir void oncontentdirremoved contentdirectoryid id contentdirectory content videocontent audiocontentlyrics audiocontent imagecontent playlistitem playlist void add content item void addbatch content[] items, optional successcallback? successcallback, optional errorcallback? errorcallback void remove playlistitem item void removebatch playlistitem[] items, optional successcallback? successcallback, optional errorcallback? errorcallback void get playlistitemarraysuccesscallback successcallback, optional errorcallback? errorcallback, optional long? count, optional long? offset void setorder playlistitem[] items, optional successcallback? successcallback, optional errorcallback? errorcallback void move playlistitem item, long delta, optional successcallback? successcallback, optional errorcallback? errorcallback playlistarraysuccesscallback void onsuccess playlist[] playlists playlistsuccesscallback void onsuccess playlist playlist playlistitemarraysuccesscallback void onsuccess playlistitem[] items thumbnailsuccesscallback void onsuccess domstring path 1 type definitions 1 1 contentdirectorystoragetype enum contentdirectorystoragetype { "internal", "external" } since 2 0 defines whether a content directory is stored on internal or external storage such as a removable memory card 1 2 contenttype enum contenttype { "image", "video", "audio", "other" }; since 2 0 defines the type of content such as an image, video, audio, or any other remark "other" type is added since tizen 2 1 and since 4 0 it is optional type, related to http //tizen org/feature/content scanning others feature one can check "other" type support using systeminfo api with tizen systeminfo getcapability "http //tizen org/feature/content scanning others" 1 3 audiocontentlyricstype enum audiocontentlyricstype { "synchronized", "unsynchronized" }; since 2 0 defines whether the lyrics supplied with an audio file is time-synchronized 1 4 imagecontentorientation enum imagecontentorientation { "normal", "flip_horizontal", "rotate_180", "flip_vertical", "transpose", "rotate_90", "transverse", "rotate_270" }; since 2 0 defines the orientation of an image 1 5 contentid content identifier typedef domstring contentid; since 2 0 1 6 contentdirectoryid content directory identifier typedef domstring contentdirectoryid; since 2 0 1 7 playlistid playlist identifier typedef domstring playlistid; since 2 3 2 interfaces 2 1 contentmanagerobject defines what is instantiated by the tizen object [nointerfaceobject] interface contentmanagerobject { readonly attribute contentmanager content; }; tizen implements contentmanagerobject; since 2 0 the tizen content object allows accessing the functionality of the content module 2 2 contentmanager the contentmanager interface provides operations to retrieve and manipulate content [nointerfaceobject] interface contentmanager { void update content content raises webapiexception ; void updatebatch content[] contents, optional successcallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void getdirectories contentdirectoryarraysuccesscallback successcallback, optional errorcallback? errorcallback raises webapiexception ; void find contentarraysuccesscallback successcallback, optional errorcallback? errorcallback, optional contentdirectoryid? directoryid, optional abstractfilter? filter, optional sortmode? sortmode, optional unsigned long? count, optional unsigned long? offset raises webapiexception ; void scanfile domstring contenturi, optional contentscansuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void scandirectory domstring contentdiruri, boolean recursive, optional contentscansuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void cancelscandirectory domstring contentdiruri raises webapiexception ; long addchangelistener contentchangecallback changecallback raises webapiexception ; void removechangelistener long listenerid raises webapiexception ; void getplaylists playlistarraysuccesscallback successcallback, optional errorcallback? errorcallback raises webapiexception ; void createplaylist domstring name, playlistsuccesscallback successcallback, optional errorcallback? errorcallback, optional playlist? sourceplaylist raises webapiexception ; void removeplaylist playlistid id, optional successcallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void createthumbnail content content, thumbnailsuccesscallback successcallback, optional errorcallback? errorcallback raises webapiexception ; }; since 2 0 methods update updates attributes of content in the content database synchronously void update content content ; since 2 0 when an application has changed some attributes of the content, this method allows writing it back to the content database privilege level public privilege http //tizen org/privilege/content write remark the editableattributes in the content interface indicates the attributes that can be changed this api does not support updating the metadata of a file parameters content the content to update exceptions webapiexception with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type invalidvalueserror, if any of the input parameters contain an invalid value with error type securityerror, if the application does not have the privilege to call this method with error type unknownerror, in any other error case code example // assume the content is a content object as a result of find method // check the description is editable, and then set a description if content editableattributes indexof "description" >= 0 { content description = "sample content"; } tizen content update content ; updatebatch updates a batch of content attributes in the content database asynchronously void updatebatch content[] contents, optional successcallback? successcallback, optional errorcallback? errorcallback ; since 2 0 when an application has changed any attributes in the array of content, this method allows writing them back to the content database the errorcallback is launched with these error types invalidvalueserror if any of the input parameters contain an invalid value unknownerror in any other error case privilege level public privilege http //tizen org/privilege/content write remark the editableattributes in the content interface indicates the attributes that can be changed this api does not support updating the metadata of a file parameters contents array of content to change successcallback [optional] [nullable] callback method to be invoked when attributes have been changed errorcallback [optional] [nullable] callback method to be invoked when an error has occurred exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method code example // the following example increases rating of an content by 1 function errorcb err { console log 'the following error occurred ' + err name ; } function successcb { console log 'attributes set successfully' ; } // assume the content is a content object as a result of find method // check the rating is editable, and then increase by 1 if content editableattributes indexof "rating" >= 0 { content rating++; } tizen content updatebatch [content], successcb, errorcb ; getdirectories gets a list of content directories getdirectories contentdirectoryarraysuccesscallback successcallback, optional errorcallback? errorcallback ; since 2 0 this method returns via callback a list of content directory objects to obtain a list of contents in a specific directory, use the find method with the directory id the errorcallback is launched with this error type unknownerror in any other error case parameters successcallback callback method to be invoked when content directories have been retrieved successfully errorcallback [optional] [nullable] callback method to be invoked when an error has occurred exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example // the following example retrieves content directories in the storage function errorcb err { console log 'the following error occurred ' + err name ; } function printdirectory directory, index, directories { console log 'directoryuri ' + directory directoryuri + ' title ' + directory title ; } function getdirectoriescb directories { directories foreach printdirectory ; } tizen content getdirectories getdirectoriescb, errorcb ; find finds contents that satisfy the conditions set by a filter find contentarraysuccesscallback successcallback, optional errorcallback? errorcallback, optional contentdirectoryid? directoryid, optional abstractfilter? filter, optional sortmode? sortmode, optional unsigned long? count, optional unsigned long? offset ; since 2 0 this method allows searching based on a supplied filter for more details on abstractfilter, see the tizen module the filter allows precise searching such as "return all songs by artist u2, ordered by name" the errorcallback is launched with these error types invalidvalueserror if any of the input parameters contain an invalid value unknownerror in any other error case privilege level public privilege http //tizen org/privilege/content read parameters successcallback callback method to be invoked when content has been retrieved errorcallback [optional] [nullable] callback method to be invoked when an error has occurred directoryid [optional] [nullable] directory id that is used to select content to retrieve in a specified directory filter [optional] [nullable] filter that is used to select content to retrieve sortmode [optional] [nullable] used to determine the sort order in which the contents are returned count [optional] [nullable] maximum amount of content to return if count is negative, invalidvalueserror is reported through the errorcallback offset [optional] [nullable] offset of the result set if offset is a negative number, invalidvalueserror is reported through the errorcallback exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method code example // the following example retrieves all songs from the album "the joshua tree", by artist "u2", ordered by the name var count = 100; var offset = 0; var sortmode = new tizen sortmode "name", "asc" ; var artistfilter = new tizen attributefilter "artists", "exactly", "u2" ; var albumfilter = new tizen attributefilter "album", "exactly", "the joshua tree" ; var filter = new tizen compositefilter "intersection", [albumfilter, artistfilter] ; function errorcb err { console log 'the following error occurred ' + err name ; } function printcontent content, index, contents { console log 'name ' + content name + ' title ' + content title + 'url ' + content contenturi + 'mime ' + content mimetype ; } function findcb contents { console log 'the joshua tree by u2 ' ; contents foreach printcontent ; // increase the offset as much as the count and then find content again if contents length === count { offset += count; tizen content find findcb, errorcb, null, filter, sortmode, count, offset ; } } tizen content find findcb, errorcb, null, filter, sortmode, count, offset ; scanfile scans a file to create or update content in the content database void scanfile domstring contenturi, optional contentscansuccesscallback? successcallback, optional errorcallback? errorcallback ; since 2 1 when an application creates or updates content, this method allows to scan it and then insert or update the content in the content database the errorcallback is launched with these error types unknownerror in case of any error detected asynchronously notsupportederror in case of trying to scan content of not supported type since 4 0 privilege level public privilege http //tizen org/privilege/content write parameters contenturi uri of content to scan successcallback [optional] [nullable] callback method to be invoked when scanning has been completed errorcallback [optional] [nullable] callback method to be invoked when an error has occurred exceptions webapiexception with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type invalidvalueserror, if any of the input parameters contain an invalid value e g given contenturi is an empty string with error type securityerror, if the application does not have the privilege to call this method code example // the following example scan 'tizen jpg' in media directory function errorcb err { console log 'the following error occurred ' + err name ; } function successcb path { console log 'scanning is completed' ; } tizen filesystem resolve "images/tizen jpg", function imagefile { tizen content scanfile imagefile touri , successcb, errorcb ; } ; scandirectory scans a content directory to create or update content in the content database void scandirectory domstring contentdiruri, boolean recursive, optional contentscansuccesscallback? successcallback, optional errorcallback? errorcallback ; since 2 4 when an application creates or updates content in a directory, this method allows to scan it and then insert or update the content in the content database if a directory must not be scanned, the file scan_ignore has to be created in it the errorcallback is launched with these error types unknownerror in case of any error detected asynchronously privilege level public privilege http //tizen org/privilege/content write parameters contentdiruri uri of a content directory to scan recursive used to determine whether the function makes recursive scan or not if set to true, the function makes recursive scan successcallback [optional] [nullable] callback method to be invoked when scanning has been completed errorcallback [optional] [nullable] callback method to be invoked when an error has occurred exceptions webapiexception with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type invalidvalueserror, if any of the input parameters contain an invalid value e g given contentdiruri is an empty string with error type securityerror, if the application does not have the privilege to call this method with error type unknownerror, if any other error occurs code example // the following example scans 'images' directory function errorcb err { console log 'the following error occurred ' + err name ; } function successcb path { console log 'scanning is completed' ; } tizen filesystem resolve "images", function directory { tizen content scandirectory directory touri , true, successcb, errorcb ; } ; cancelscandirectory cancels a scan process of a content directory void cancelscandirectory domstring contentdiruri ; since 2 4 when a scan of a given directory is running it may be canceled by this function privilege level public privilege http //tizen org/privilege/content write parameters contentdiruri uri of a content directory with a scan process running which is canceled exceptions webapiexception with error type invalidvalueserror, if any of the input parameters contain an invalid value e g given contentdiruri is an empty string with error type securityerror, if the application does not have the privilege to call this method with error type unknownerror, if any other error occurs code example tizen content cancelscandirectory directory touri ; addchangelistener adds a listener which receives notifications when content changes long addchangelistener contentchangecallback changecallback ; since 3 0 parameters changecallback callback to be invoked when a content change is detected return value long identifier of the newly added listener exceptions webapiexception with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type aborterror, if the operation cannot be finished properly code example var listener = { oncontentadded function content { console log content contenturi + ' content is added' ; }, oncontentupdated function content { console log content contenturi + ' content is updated' ; }, oncontentremoved function id { console log id + ' is removed' ; }, oncontentdiradded function contentdir { console log contentdir directoryuri + ' content directory is added' ; }, oncontentdirupdated function contentdir { console log contentdir directoryuri + ' content directory is updated' ; }, oncontentdirremoved function id { console log id + ' directory is removed' ; } }; // adds the listener var listenerid = tizen content addchangelistener listener ; console log 'listener id ' + listenerid ; output example listener id 1 removechangelistener removes a listener which receives notifications about content changes void removechangelistener long listenerid ; since 3 0 parameters listenerid identifier of the listener to be removed it is returned by addchangelistener when a listener is successfully added exceptions webapiexception with error type aborterror, if the operation cannot be finished properly code example var listener = { oncontentadded function content { console log content contenturi + ' content is added' ; }, oncontentupdated function content { console log content contenturi + ' content is updated' ; }, oncontentremoved function id { console log id + ' is removed' ; }, oncontentdiradded function contentdir { console log contentdir directoryuri + ' content directory is added' ; }, oncontentdirupdated function contentdir { console log contentdir directoryuri + ' content directory is updated' ; }, oncontentdirremoved function id { console log id + ' directory is removed' ; } }; var listenerid = tizen content addchangelistener listener ; // do some job here and when the listener is not needed anymore remove it // removes the listener tizen content removechangelistener listenerid ; setchangelistener sets a listener to receive notifications of content changes deprecated deprecated since 3 0 instead, addchangelistener allows application developers to add a listener and get notified when content is added, removed or updated on a device void setchangelistener contentchangecallback changecallback ; since 2 1 privilege level public privilege http //tizen org/privilege/content read parameters changecallback a callback to be invoked for receiving a content change notification exceptions webapiexception with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type invalidvalueserror, if any of the input parameters contain an invalid value with error type securityerror, if the application does not have the privilege to call this method with error type unknownerror, if any other error occurs code example var listener= { oncontentadded function content { console log content contenturi + ' content is added' ; }, oncontentupdated function content { console log content contenturi + ' content is updated' ; }, oncontentremoved function id { console log id + ' is removed' ; }, oncontentdiradded function contentdir { console log contentdir directoryuri + ' content directory is added' ; }, oncontentdirupdated function contentdir { console log contentdir directoryuri + ' content directory is updated' ; }, oncontentdirremoved function id { console log id + ' directory is removed' ; } }; // registers to be notified when the content changes tizen content setchangelistener listener ; unsetchangelistener unsets the listener to unsubscribe from receiving notifications for content changes deprecated deprecated since 3 0 instead, use removechangelistener void unsetchangelistener ; since 2 1 privilege level public privilege http //tizen org/privilege/content read exceptions webapiexception with error type securityerror, if the application does not have the privilege to call this method with error type unknownerror, if any other error occurs code example tizen content unsetchangelistener ; getplaylists gets all playlists void getplaylists playlistarraysuccesscallback successcallback, optional errorcallback? errorcallback ; since 2 3 the errorcallback is launched with these error types unknownerror in case of any error privilege level public privilege http //tizen org/privilege/content read parameters successcallback callback method to be invoked when retrieving a list of all playlists completes errorcallback [optional] [nullable] callback method to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method code example var gplaylists; function getplaylistsfail err { console log "getplaylists failed " + err ; } function getplaylistssuccess playlists { var cur, i; gplaylists = playlists; for i = 0; i < gplaylists length; ++i { cur = gplaylists[i]; console log "[" + i + "] name " + cur name + " num tracks " + cur numberoftracks ; } } tizen content getplaylists getplaylistssuccess, getplaylistsfail ; createplaylist creates a new playlist void createplaylist domstring name, playlistsuccesscallback successcallback, optional errorcallback? errorcallback, optional playlist? sourceplaylist ; since 2 3 the errorcallback is launched with these error types invalidvalueserror if name is empty or is same as the name of an existing playlist unknownerror in case of any other error privilege level public privilege http //tizen org/privilege/content write parameters name name of the new playlist case sensitive successcallback callback method to be invoked to provide a created playlist errorcallback [optional] [nullable] callback method to be invoked when an error occurs sourceplaylist [optional] [nullable] optional existing playlist to clone exceptions webapiexception with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method code example var gplaylists; var gplaylist; function getplaylistsfail err { console log "getplaylists failed " + err message ; } function getplaylistssuccess playlists { var cur, i; gplaylists = playlists; for i = 0; i < gplaylists length; ++i { cur = gplaylists[i]; console log "[" + i + "] name " + cur name + " num tracks " + cur numberoftracks ; } } function findsuccess contents { if contents length > 0 { gplaylist add contents[0] ; } tizen content getplaylists getplaylistssuccess, getplaylistsfail ; } function findfail err { console log "find fail " + err message ; } function createsuccess playlist { console log "create success" ; gplaylist = playlist; tizen content find findsuccess, findfail, null, new tizen attributefilter "type", "exactly", "audio" ; } function createfail err { console log "create fail " + err message ; } tizen content createplaylist "my new playlist", createsuccess, createfail ; removeplaylist removes a playlist void removeplaylist playlistid id, optional successcallback? successcallback, optional errorcallback? errorcallback ; since 2 3 the errorcallback is launched with these error types unknownerror in case of any error privilege level public privilege http //tizen org/privilege/content write parameters id identifier of a playlist to remove successcallback [optional] [nullable] callback method to be invoked when removing a playlist completes errorcallback [optional] [nullable] callback method to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method code example var gplaylists; function removeplaylistsuccess { console log "removeplaylist success" ; } function removeplaylistfail err { console log "removeplaylist fail " + err ; } function getplaylistsfail err { console log "getplaylists failed " + err ; } function getplaylistssuccess playlists { var cur, i; gplaylists = playlists; for i = 0; i < gplaylists length; ++i { cur = gplaylists[i]; console log "[" + i + "] name " + cur name + " num tracks " + cur numberoftracks ; } if gplaylists length < 1 { console log "please add at least 1 playlist" ; return; } console log "will remove playlist at index [0] name " + gplaylists[0] name ; tizen content removeplaylist gplaylists[0] id, removeplaylistsuccess, removeplaylistfail ; } tizen content getplaylists getplaylistssuccess, getplaylistsfail ; createthumbnail creates a content's thumbnail void createthumbnail content content, thumbnailsuccesscallback successcallback, optional errorcallback? errorcallback ; since 3 0 the errorcallback is launched with these error types invalidvalueserror in case of invalid content object aborterror in case of any error privilege level public privilege http //tizen org/privilege/content write parameters content content object for which a new thumbnail will be created successcallback callback method to be invoked when the thumbnail is created errorcallback [optional] [nullable] callback method to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method code example function createcb path { console log "the thumbnail path is " + path ; } function findcb contents { if contents length > 0 { tizen content createthumbnail contents[0], createcb ; } } tizen content find findcb ; output example the thumbnail path is /home/owner/share/media/ thumb/phone/ jpg-bed1d5f494830f7a52e1217f1e924aff jpg 2 3 contentarraysuccesscallback the callback function used to return a list of content objects [callback=functiononly, nointerfaceobject] interface contentarraysuccesscallback { void onsuccess content[] contents ; }; since 2 0 methods onsuccess called when the list of content is retrieved successfully void onsuccess content[] contents ; since 2 0 parameters contents the array of content objects 2 4 contentdirectoryarraysuccesscallback the callback function used to return a list of contentdirectory objects [callback=functiononly, nointerfaceobject] interface contentdirectoryarraysuccesscallback { void onsuccess contentdirectory[] directories ; }; since 2 0 methods onsuccess called when the directory list is retrieved successfully void onsuccess contentdirectory[] directories ; since 2 0 parameters directories the array of contentdirectory objects 2 5 contentscansuccesscallback the callback function used to return content or content directory to scan [callback=functiononly, nointerfaceobject] interface contentscansuccesscallback { void onsuccess domstring uri ; }; since 2 1 methods onsuccess called when the scanning has been completed void onsuccess domstring uri ; since 2 1 remark this callback is also invoked upon success of the scandirectory method since tizen 2 4 therefore, the uri parameter may now also be the uri of a contentdirectory object parameters uri the uri of the content or the contentdirectory object 2 6 contentchangecallback this interface specifies a set of methods that are invoked every time a content change occurs [callback, nointerfaceobject] interface contentchangecallback { void oncontentadded content content ; void oncontentupdated content content ; void oncontentremoved contentid id ; void oncontentdiradded contentdirectory contentdir ; void oncontentdirupdated contentdirectory contentdir ; void oncontentdirremoved contentdirectoryid id ; }; since 2 1 methods oncontentadded called when content is added void oncontentadded content content ; since 2 1 parameters content the content to add oncontentupdated called when content is updated void oncontentupdated content content ; since 2 1 parameters content the content to update oncontentremoved called when content is removed void oncontentremoved contentid id ; since 2 1 parameters id the id of removed content oncontentdiradded called when a content directory is added void oncontentdiradded contentdirectory contentdir ; since 2 4 parameters contentdir the added content directory oncontentdirupdated called when a content directory is updated void oncontentdirupdated contentdirectory contentdir ; since 2 4 parameters contentdir the content directory?after the update operation oncontentdirremoved called when a content directory is removed void oncontentdirremoved contentdirectoryid id ; since 2 4 parameters id the id of removed content directory 2 7 contentdirectory the contentdirectory interface provides access to properties of a content directory [nointerfaceobject] interface contentdirectory { readonly attribute contentdirectoryid id; readonly attribute domstring directoryuri; readonly attribute domstring title; readonly attribute contentdirectorystoragetype storagetype; readonly attribute date? modifieddate; }; since 2 0 attributes readonly contentdirectoryid id the opaque content directory identifier since 2 0 readonly smartcontrollermanager directoryuri the directory path on the device since 2 0 readonly smartcontrollermanager title the directory name since 2 0 readonly contentdirectorystoragetype storagetype the type of device storage since 2 0 readonly date modifieddate nullable the last modified date for a directory since 2 0 2 8 content the content interface provides access to the properties of a content item [nointerfaceobject] interface content { readonly attribute domstring[] editableattributes; readonly attribute contentid id; attribute domstring name; readonly attribute contenttype type; readonly attribute domstring mimetype; readonly attribute domstring title; readonly attribute domstring contenturi; readonly attribute domstring[]? thumbnailuris; readonly attribute date? releasedate; readonly attribute date? modifieddate; readonly attribute unsigned long size; attribute domstring? description; attribute unsigned long rating; attribute boolean isfavorite; }; since 2 0 attributes readonly smartcontrollermanager editableattributes the list of attributes that are editable to the local backend using the update or updatebatch method since 2 0 readonly contentid id the opaque content identifier since 2 0 domstring name the content name the initial value is the file name of the content since 2 1 readonly contenttype type the content type since 2 0 readonly smartcontrollermanager mimetype the content mime type since 2 0 readonly smartcontrollermanager title the content title since 2 0 readonly smartcontrollermanager contenturi the uri to access the content since 2 0 readonly smartcontrollermanager thumbnailuris thumbnailuris nullable the array of content thumbnail uris since 2 0 readonly date releasedate nullable the date when content has been released publicly if only the release year is known, then the month and date are set to january and 1st respectively since 2 0 readonly date modifieddate nullable the last modified date for a content item since 2 0 readonly unsigned long size the file size of the content in bytes since 2 0 domstring description nullable the content description since 2 0 unsigned long rating the content rating this value can range from 0 to 10 since 2 0 boolean isfavorite boolean value that indicates whether a content item is marked as a favorite since 2 3 2 9 videocontent the videocontent interface extends a basic content object with video-specific attributes [nointerfaceobject] interface videocontent content { attribute simplecoordinates? geolocation; readonly attribute domstring? album; readonly attribute domstring[]? artists; readonly attribute unsigned long duration; readonly attribute unsigned long width; readonly attribute unsigned long height; }; since 2 0 attributes simplecoordinates geolocation nullable the geographical location where the video has been made since 2 0 readonly smartcontrollermanager album nullable the album name to which the video belongs since 2 0 readonly smartcontrollermanager artists nullable the list of artists who created the video since 2 0 readonly unsigned long duration the video duration in milliseconds since 2 0 readonly unsigned long width the width of a video in pixels since 2 0 readonly unsigned long height the height of the video in pixels since 2 0 2 10 audiocontentlyrics the audiocontentlyrics interface provides lyrics for music [nointerfaceobject] interface audiocontentlyrics { readonly attribute audiocontentlyricstype type; readonly attribute unsigned long[] timestamps; readonly attribute domstring[] texts; }; since 2 0 attributes readonly audiocontentlyricstype type the type of lyrics, that is, whether they are synchronized with the music since 2 0 readonly unsigned unsigned long timestamps the array of timestamps in milliseconds for lyrics if the lyrics are not synchronized if there is no time information for the lyrics the array is undefined since 2 0 readonly smartcontrollermanager texts the array of lyrics snippets if the lyrics are not synchronized, the array has only one member with full lyrics since 2 0 2 11 audiocontent the audiocontent interface extends a basic content object with audio-specific attributes [nointerfaceobject] interface audiocontent content { readonly attribute domstring? album; readonly attribute domstring[]? genres; readonly attribute domstring[]? artists; readonly attribute domstring[]? composers; readonly attribute audiocontentlyrics? lyrics; readonly attribute domstring? copyright; readonly attribute unsigned long bitrate; readonly attribute unsigned short? tracknumber; readonly attribute unsigned long duration; }; since 2 0 attributes readonly smartcontrollermanager album nullable the album name to which the audio belongs since 2 0 readonly smartcontrollermanager genres nullable the list of genres to which the audio belongs since 2 0 readonly smartcontrollermanager artists nullable the list of artists who created the audio since 2 0 readonly smartcontrollermanager composers nullable the list of composers for the music since 2 0 readonly audiocontentlyrics lyrics nullable the lyrics of a song in an audio file since 2 0 readonly smartcontrollermanager copyright nullable the copyright information since 2 0 readonly unsigned long bitrate the audio bitrate in bits per second by default, this value is 0 since 2 0 readonly unsigned short tracknumber nullable the track number if the audio belongs to an album since 2 0 readonly unsigned long duration the audio duration in milliseconds since 2 0 2 12 imagecontent the imagecontent interface extends a basic content object with image-specific attributes [nointerfaceobject] interface imagecontent content { attribute simplecoordinates? geolocation; readonly attribute unsigned long width; readonly attribute unsigned long height; attribute imagecontentorientation orientation; }; since 2 0 attributes simplecoordinates geolocation nullable the geographical location where the image has been made since 2 0 readonly unsigned long width the width of an image in pixels since 2 0 readonly unsigned long height the height of an image in pixels since 2 0 imagecontentorientation orientation the image orientation since 2 0 2 13 playlistitem the playlistitem interface represents a playlist item [nointerfaceobject] interface playlistitem { readonly attribute content content; }; since 2 3 attributes readonly content content content contained in this playlist item since 2 3 2 14 playlist the playlist interface represents a playlist [nointerfaceobject] interface playlist { readonly attribute playlistid id; attribute domstring name raises webapiexception ; readonly attribute long numberoftracks; attribute domstring? thumbnailuri raises webapiexception ; void add content item raises webapiexception ; void addbatch content[] items, optional successcallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void remove playlistitem item raises webapiexception ; void removebatch playlistitem[] items, optional successcallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void get playlistitemarraysuccesscallback successcallback, optional errorcallback? errorcallback, optional long? count, optional long? offset raises webapiexception ; void setorder playlistitem[] items, optional successcallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void move playlistitem item, long delta, optional successcallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; }; since 2 3 attributes readonly playlistid id identifier of a playlist since 2 3 domstring name name of a playlist case sensitive and unique when name is set, the change is recorded in the database since 2 3 privilege level public privilege http //tizen org/privilege/content write exceptions webapiexception with error type invalidvalueserror, when assigning an invalid value e g playlist of the same name already exists with error type securityerror, if the application does not have the privilege to change this attribute readonly long numberoftracks number of playlist items in the playlist since 2 3 domstring thumbnailuri nullable thumbnail uri of a playlist by default, this attribute is set to null when thumbnailuri is set, the change is recorded in the database since 2 3 privilege level public privilege http //tizen org/privilege/content write exceptions webapiexception with error type invalidvalueserror, when assigning an invalid value e g if the uri does not start with "file ///" with error type securityerror, if the application does not have the privilege to change this attribute methods add adds a content item to a playlist void add content item ; since 2 3 see code example for the createplaylist method privilege level public privilege http //tizen org/privilege/content write parameters item content to add exceptions webapiexception with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method with error type unknownerror, if any other error occurs addbatch adds tracks to a playlist as a batch, asynchronously void addbatch content[] items, optional successcallback? successcallback, optional errorcallback? errorcallback ; since 2 3 the errorcallback is launched with these error types unknownerror in case of any error privilege level public privilege http //tizen org/privilege/content write parameters items list of tracks content objects to add successcallback [optional] [nullable] callback method to be invoked when adding a list of content items to a playlist completes successfully errorcallback [optional] [nullable] callback method to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method remove removes a track from a playlist void remove playlistitem item ; since 2 3 privilege level public privilege http //tizen org/privilege/content write parameters item playlist item to remove exceptions webapiexception with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method with error type unknownerror, if any other error occurs code example var gplaylists, gitems, gcurplaylist; function get2fail err { console log "get items after remove failed " + err ; } function get2success items { console log "playlist items " ; for var i = 0; i < items length ; ++i { console log "[" + i + "] name " + items[i] content name ; } } function getsuccess items { gitems = items; if gitems length < 1 { console log "please add at least 1 tracks to playlist!" ; return; } console log "original playlist " ; for var i = 0; i < gitems length ; ++i { console log "[" + i + "] name " + gitems[i] content name ; } console log "will remove item at index [0] name " + gitems[0] content name ; gcurplaylist remove gitems[0] ; gcurplaylist get get2success, get2fail ; } function getfail err { console log "get items failed " + err ; } function getplaylistsfail err { console log "getplaylists failed " + err ; } function getplaylistssuccess playlists { gplaylists = playlists; if gplaylists length === 0 { console log "please create at least 1 playlist!" ; return; } gcurplaylist = gplaylists[0]; gcurplaylist get getsuccess, getfail ; } tizen content getplaylists getplaylistssuccess, getplaylistsfail ; removebatch removes tracks from a playlist as a batch, asynchronously void removebatch playlistitem[] items, optional successcallback? successcallback, optional errorcallback? errorcallback ; since 2 3 the errorcallback is launched with these error types unknownerror in case of any other error privilege level public privilege http //tizen org/privilege/content write parameters items list of tracks to remove successcallback [optional] [nullable] callback method to be invoked when removing a list of content items from a playlist completes successfully errorcallback [optional] [nullable] callback method to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method code example var gplaylists, gitems, gcurplaylist; function get2fail err { console log "get items after remove batch failed " + err ; } function get2success items { console log "playlist after remove batch " ; for var i = 0; i < items length ; ++i { console log "[" + i + "] name " + items[i] content name ; } } function removebatchsuccess { console log "removebatch success" ; gcurplaylist get get2success, get2fail ; } function removebatchfail err { console log "removebatch failed " + err ; } function getsuccess items { gitems = items; if gitems length < 4 { console log "please add at least 4 tracks to playlist!" ; return; } console log "original playlist " ; for var i = 0; i < gitems length ; ++i { console log "[" + i + "] name " + gitems[i] content name ; } console log "will remove items at index [0] name " + gitems[0] content name + " and at index [2] name " + gitems[2] content name + " " ; gcurplaylist removebatch [gitems[2], gitems[0]], removebatchsuccess, removebatchfail ; } function getfail err { console log "get items failed " + err ; } function getplaylistsfail err { console log "getplaylists failed " + err ; } function getplaylistssuccess playlists { gplaylists = playlists; if gplaylists length === 0 { console log "please create at least 1 playlist!" ; return; } gcurplaylist = gplaylists[0]; gcurplaylist get getsuccess, getfail ; } tizen content getplaylists getplaylistssuccess, getplaylistsfail ; get gets playlist items from a playlist void get playlistitemarraysuccesscallback successcallback, optional errorcallback? errorcallback, optional long? count, optional long? offset ; since 2 3 the errorcallback is launched with these error types invalidvalueserror if any of the input parameters contain an invalid value e g count or offset is a negative number unknownerror in case of any error privilege level public privilege http //tizen org/privilege/content read parameters successcallback callback method to be invoked for a list of tracks in the playlist errorcallback [optional] [nullable] callback method to be invoked when an error occurs count [optional] [nullable] number of playlist items to return if the count is not passed, all playlist items are retrieved offset [optional] [nullable] offset of the track from the beginning of the playlist the default value is 0 it means no offset exceptions webapiexception with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method code example var gplaylists, gitems, gcurplaylist; function getsuccess items { gitems = items; console log "playlist items " ; for var i = 0; i < items length ; ++i { console log "[" + i + "] name " + items[i] name ; } } function getfail err { console log "get items failed " + err ; } function getplaylistsfail err { console log "getplaylists failed " + err ; } function getplaylistssuccess playlists { gplaylists = playlists; if gplaylists length === 0 { console log "please create at least 1 playlist!" ; return; } gcurplaylist = gplaylists[0]; // to retrieves all playlist items of 'gcurplaylist' playlist gcurplaylist get getsuccess, getfail ; } tizen content getplaylists getplaylistssuccess, getplaylistsfail ; setorder changes the play order of all playlist items in the playlist void setorder playlistitem[] items, optional successcallback? successcallback, optional errorcallback? errorcallback ; since 2 3 the errorcallback is launched with these error types invalidvalueserror in case the item in the passed items array is not inside this playlist, or the items array does not contain all items from the playlist unknownerror in case of any other error privilege level public privilege http //tizen org/privilege/content write parameters items list of playlist items to set in play order this list must include all playlist items of this playlist if not, invalidvalueserror is thrown successcallback [optional] [nullable] callback method to be invoked when changing the positions of items in the playlist is successfully completed errorcallback [optional] [nullable] callback method to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method code example var gplaylists, gitems, gcurplaylist, gexpectedorder; function get2fail err { console log "get items after set order failed " + err ; } function get2success items { console log "playlist order after setorder " ; for var i = 0; i < items length ; ++i { console log "[" + i + "] name " + items[i] content name ; } } function setordersuccess { console log "set items order success" ; gcurplaylist get get2success, get2fail ; } function setorderfail err { console log "set items order failed " + err ; } function getsuccess items { gitems = items; if gitems length < 2 { console log "please add at least 2 tracks to playlist!" ; return; } console log "original order " ; for var i = 0; i < gitems length ; ++i { console log "[" + i + "] name " + gitems[i] content name ; } gexpectedorder = gitems slice 0 ; gexpectedorder reverse ; console log "new order " ; for var i = 0; i < gexpectedorder length ; ++i { console log "[" + i + "] name " + gexpectedorder[i] content name ; } gcurplaylist setorder gexpectedorder, setordersuccess, setorderfail ; } function getfail err { console log "get items failed " + err ; } function getplaylistsfail err { console log "getplaylists failed " + err ; } function getplaylistssuccess playlists { gplaylists = playlists; if gplaylists length === 0 { console log "please create at least 1 playlist!" ; return; } gcurplaylist = gplaylists[0]; gcurplaylist get getsuccess, getfail ; } tizen content getplaylists getplaylistssuccess, getplaylistsfail ; move moves the specified item up or down a specified amount in the play order move playlistitem item, long delta, optional successcallback? successcallback, optional errorcallback? errorcallback ; since 2 3 if current index + delta is < 0 then the item is moved to the first position in the playlist ??number of tracks then the item is moved to the last position in the playlist the errorcallback is launched with these error types invalidvalueserror in case the item in the passed items array is not inside this playlist or some item of this playlist is not included in items unknownerror in case of any other error privilege level public privilege http //tizen org/privilege/content write parameters item playlist item to move delta how many positions to move the item, negative value means move up, positive means move down successcallback [optional] [nullable] callback method to be invoked when the playlist item has successfully been moved errorcallback [optional] [nullable] callback method to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method code example var gplaylists, gitems, gcurplaylist; function get2fail err { console log "get items after move item failed " + err ; } function get2success items { console log "playlist order after move " ; for var i = 0; i < items length ; ++i { console log "[" + i + "] name " + items[i] content name ; } } function movesuccess { console log "move item success" ; gcurplaylist get get2success, get2fail ; } function movefail err { console log "move item failed " + err ; } function getsuccess items { gitems = items; if gitems length < 2 { console log "please add at least 2 tracks to playlist!" ; return; } console log "original order " ; for var i = 0; i < gitems length ; ++i { console log "[" + i + "] name " + gitems[i] content name ; } console log "will move item at index [1] name " + gitems[1] content name + " up by one place to [0] " ; gcurplaylist move gitems[1], -1, movesuccess, movefail ; gitems unshift gitems splice 1, 1 [0] ; } function getfail err { console log "get items failed " + err ; } function getplaylistsfail err { console log "getplaylists failed " + err ; } function getplaylistssuccess playlists { gplaylists = playlists; if gplaylists length === 0 { console log "please create at least 1 playlist!" ; return; } gcurplaylist = gplaylists[0]; gcurplaylist get getsuccess, getfail ; } tizen content getplaylists getplaylistssuccess, getplaylistsfail ; 2 15 playlistarraysuccesscallback the playlistarraysuccesscallback interface specifies a success callback that is invoked when all existing playlists are retrieved successfully [callback=functiononly, nointerfaceobject] interface playlistarraysuccesscallback { void onsuccess playlist[] playlists ; }; since 2 3 it is used in tizen content getplaylists methods onsuccess called when the tizen content getplaylists method completes successfully onsuccess playlist[] playlists ; since 2 3 parameters playlists list of all playlists on a device 2 16 playlistsuccesscallback the playlistsuccesscallback interface specifies a success callback that is invoked when a new playlist is successfully created [callback=functiononly, nointerfaceobject] interface playlistsuccesscallback { void onsuccess playlist playlist ; }; since 2 3 it is used in tizen content createplaylist methods onsuccess called when the tizen content createplaylist method completes successfully onsuccess playlist playlist ; since 2 3 parameters playlist newly created playlist 2 17 playlistitemarraysuccesscallback the playlistitemarraysuccesscallback interface specifies a success callback that is invoked when a list of playlist items are successfully retrieved [callback=functiononly, nointerfaceobject] interface playlistitemarraysuccesscallback { void onsuccess playlistitem[] items ; }; since 2 3 methods onsuccess called when the playlist get method completes successfully onsuccess playlistitem[] items ; since 2 3 parameters items list of playlist items 2 18 thumbnailsuccesscallback the thumbnailsuccesscallback interface specifies a success callback that is invoked when a content's thumbnail is successfully created [callback=functiononly, nointerfaceobject] interface thumbnailsuccesscallback { void onsuccess domstring path ; }; since 3 0 methods onsuccess called when the tizen content createthumbnail method completes successfully onsuccess domstring path ; since 3 0 parameters path path of the created thumbnail 3 full webidl module content { enum contentdirectorystoragetype { "internal", "external" }; enum contenttype { "image", "video", "audio", "other" }; enum audiocontentlyricstype { "synchronized", "unsynchronized" }; enum imagecontentorientation { "normal", "flip_horizontal", "rotate_180", "flip_vertical", "transpose", "rotate_90", "transverse", "rotate_270" }; typedef domstring contentid; typedef domstring contentdirectoryid; typedef domstring playlistid; [nointerfaceobject] interface contentmanagerobject { readonly attribute contentmanager content; }; tizen implements contentmanagerobject; [nointerfaceobject] interface contentmanager { void update content content raises webapiexception ; void updatebatch content[] contents, optional successcallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void getdirectories contentdirectoryarraysuccesscallback successcallback, optional errorcallback? errorcallback raises webapiexception ; void find contentarraysuccesscallback successcallback, optional errorcallback? errorcallback, optional contentdirectoryid? directoryid, optional abstractfilter? filter, optional sortmode? sortmode, optional unsigned long? count, optional unsigned long? offset raises webapiexception ; void scanfile domstring contenturi, optional contentscansuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void scandirectory domstring contentdiruri, boolean recursive, optional contentscansuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void cancelscandirectory domstring contentdiruri raises webapiexception ; ```java void contentchangecallback changecallback raises webapiexception ; void removechangelistener long listenerid raises webapiexception ; void setchangelistener contentchangecallback changecallback raises webapiexception ; void unsetchangelistener raises webapiexception ; void getplaylists playlistarraysuccesscallback successcallback, optional errorcallback? errorcallback raises webapiexception ; void createplaylist domstring name, playlistsuccesscallback successcallback, optional errorcallback? errorcallback, optional playlist? sourceplaylist raises webapiexception ; void removeplaylist playlistid id, optional successcallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void createthumbnail content content, thumbnailsuccesscallback successcallback, optional errorcallback? errorcallback raises webapiexception ; }; [callback=functiononly, nointerfaceobject] interface contentarraysuccesscallback { void onsuccess content[] contents ; }; [callback=functiononly, nointerfaceobject] interface contentdirectoryarraysuccesscallback { void onsuccess contentdirectory[] directories ; }; [callback=functiononly, nointerfaceobject] interface contentscansuccesscallback { void onsuccess domstring uri ; }; [callback, nointerfaceobject] interface contentchangecallback { void oncontentadded content content ; void oncontentupdated content content ; void oncontentremoved contentid id ; void oncontentdiradded contentdirectory contentdir ; void oncontentdirupdated contentdirectory contentdir ; void oncontentdirremoved contentdirectoryid id ; }; [nointerfaceobject] interface contentdirectory { readonly attribute contentdirectoryid id; readonly attribute domstring directoryuri; readonly attribute domstring title; readonly attribute contentdirectorystoragetype storagetype; readonly attribute date? modifieddate; }; [nointerfaceobject] interface content { readonly attribute domstring[] editableattributes; readonly attribute contentid id; attribute domstring name; readonly attribute contenttype type; readonly attribute domstring mimetype; readonly attribute domstring title; readonly attribute domstring contenturi; readonly attribute domstring[]? thumbnailuris; readonly attribute date? releasedate; readonly attribute date? modifieddate; readonly attribute unsigned long size; attribute domstring? description; attribute unsigned long rating; attribute boolean isfavorite; }; [nointerfaceobject] interface videocontent content { attribute simplecoordinates? geolocation; readonly attribute domstring? album; readonly attribute domstring[]? artists; readonly attribute unsigned long duration; readonly attribute unsigned long width; readonly attribute unsigned long height; }; [nointerfaceobject] interface audiocontentlyrics { readonly attribute audiocontentlyricstype type; readonly attribute unsigned long[] timestamps; readonly attribute domstring[] texts; }; [nointerfaceobject] interface audiocontent content { readonly attribute domstring? album; readonly attribute domstring[]? genres; readonly attribute domstring[]? artists; readonly attribute domstring[]? composers; readonly attribute audiocontentlyrics? lyrics; readonly attribute domstring? copyright; readonly attribute unsigned long bitrate; readonly attribute unsigned short? tracknumber; readonly attribute unsigned long duration; }; [nointerfaceobject] interface imagecontent content { attribute simplecoordinates? geolocation; readonly attribute unsigned long width; readonly attribute unsigned long height; attribute imagecontentorientation orientation; }; [nointerfaceobject] interface playlistitem { readonly attribute content content; }; [nointerfaceobject] interface playlist { readonly attribute playlistid id; attribute domstring name raises webapiexception ; readonly attribute long numberoftracks; attribute domstring? thumbnailuri raises webapiexception ; void add content item raises webapiexception ; void addbatch content[] items, optional successcallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void remove playlistitem item raises webapiexception ; void removebatch playlistitem[] items, optional successcallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void get playlistitemarraysuccesscallback successcallback, optional errorcallback? errorcallback, optional long? count, optional long? offset raises webapiexception ; void setorder playlistitem[] items, optional successcallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void move playlistitem item, long delta, optional successcallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; }; [callback=functiononly, nointerfaceobject] interface playlistarraysuccesscallback { void onsuccess playlist[] playlists ; }; [callback=functiononly, nointerfaceobject] interface playlistsuccesscallback { void onsuccess playlist playlist ; }; [callback=functiononly, nointerfaceobject] interface playlistitemarraysuccesscallback { void onsuccess playlistitem[] items ; }; [callback=functiononly, nointerfaceobject] interface thumbnailsuccesscallback { void onsuccess domstring path ; }; };

billing api to use samsung product api, <script type="text/javascript" src="$webapis/webapis/webapis js"></script> should be loaded in index html this module defines the billing samsung checkout functionalities provided by the tizen samsung product api since 2 4 product tv privilege level public privilege http //developer samsung com/privilege/billing summary of interfaces and methods interface method billingmanagerobject billingmanager void buyitem domstring appid, tvservertype servertype, domstring paymentdetails, billingbuydatasuccesscallback onsuccess, optional errorcallback? onerror ;void getproductslist domstring appid, domstring countrycode, domstring pagesize, domstring pagenumber, domstring checkvalue, tvservertype servertype, billingproductslistcallback onsuccess, optional errorcallback? onerror ;void applyinvoice domstring appid, domstring customid, domstring invoiceid, domstring countrycode, tvservertype servertype, billingapplyinvoicecallback onsuccess, optional errorcallback? onerror ;void verifyinvoice domstring appid, domstring customid, domstring invoiceid, domstring countrycode, tvservertype servertype, billingverifyinvoicecallback onsuccess, optional errorcallback? onerror ;void getservicecountryavailability domstring appid, domstring[] countrycodes, domstring checkvalue, tvservertype servertype, billinggetservicecountryavailabilitycallback onsuccess, optional errorcallback? onerror ;void getuserpurchaselist domstring appid, domstring customid, domstring countrycode, domstring pagenumber, domstring checkvalue, tvservertype servertype, billinggetuserpurchaselistcallback onsuccess, optional errorcallback? onerror ;void cancelsubscription domstring appid, domstring invoiceid, domstring customid, domstring countrycode, tvservertype servertype, billingcancelsubscriptioncallback onsuccess, optional errorcallback? onerror ;void isserviceavailable tvservertype servertype, billingisserviceavailablecallback onsuccess, optional errorcallback? onerror ;domstring getversion ; billingbuydatasuccesscallback void onsuccess billingbuydata data ; billingbuydata billingproductslistcallback void onsuccess productslistdata data ; billingapplyinvoicecallback void onsuccess applyinvoicedata data ; billingverifyinvoicecallback void onsuccess verifyinvoicedata data ; billinggetuserpurchaselistcallback void onsuccess userpurchasedata data ; billinggetservicecountryavailabilitycallback void onsuccess servicecountryavailabilitydata data ; billingcancelsubscriptioncallback void onsuccess cancelsubscriptiondata data ; billingisserviceavailablecallback void onsuccess serviceavailabledata data ; 1 type definitions 1 1 tvservertype specifies billing server types enum tvservertype { "dev", "prd" }; the following values are supported dev staging server prd operating server 1 2 historytype specifies product types for the purchase history enum historytype { "all", "subscription", "non-subscription" }; the following values are supported all all product types this type is not supported since 2019 product subscription subscription products only non-subscription non-subscription products only 1 3 productslistdata defines a dictionary for product list data returned by the getproductslist api dictionary productslistdata { domstring apiresult; }; the following values are supported apiresult getproductslist api result dictionary in json format this value is json string type data, so please use it by json parsing after you parse this value, you can use it in productslistapiresult format at the below 1 4 productslistapiresult defines a dictionary for the productslistdata dictionary apiresult parameter dictionary productslistapiresult { domstring cpstatus; domstring? cpresult; long totalcount; domstring checkvalue; itemdetails[]? itemdetails; }; the following values are supported cpstatus dpi result code returns "100000" on success and other codes on failure cpresult [optional] optional additional message "eof" last page of the product list "hasnext true" product list has further pages other error message, depending on the dpi result code totalcount total number of invoices checkvalue security check value itemdetails [optional] optional dictionary in json format 1 5 itemdetails defines a dictionary for the productslistapiresult dictionary 'itemdetails' parameter dictionary itemdetails { long seq; domstring itemid; domstring itemtitle; long itemtype; long? period; long price; domstring currencyid; productsubscriptioninfo? subscriptioninfo; }; the following values are supported seq sequence number 1 ~ totalcount itemid product id itemtitle product name itemtype product type "1" consumable "2" non-consumable "3" limited-period "4" subscription period [optional] limited period product duration, in minutes price product price, in "xxxx yy" format currencyid currency code subscriptioninfo [optional] subscription information mandatory for subscription products 1 6 productsubscriptioninfo defines a dictionary for the itemdetails dictionary 'subscriptioninfo' parameter dictionary productsubscriptioninfo { domstring paymentcycleperiod; long paymentcyclefrq; long paymentcycle; }; the following values are supported paymentcycleperiod subscription payment period "d" days "w" weeks "m" months paymentcyclefrq payment cycle frequency paymentcycle number of payment cycles 1 7 applyinvoicedata defines a dictionary for data returned by the applyinvoice api dictionary applyinvoicedata { domstring apiresult; }; the following values are supported apiresult applyinvoice api result dictionary in json format this value is json string type data, so please use it by json parsing after you parse this value, you can use it in applyinvoiceapiresult format at the below 1 8 applyinvoiceapiresult defines a dictionary for the applyinvoicedata dictionary 'apiresult' parameter dictionary applyinvoiceapiresult { domstring cpstatus; domstring? cpresult; domstring appliedtime; }; the following values are supported cpstatus dpi result code returns "100000" on success and other codes on failure cpresult [optional] optional additional message "success" other error message, depending on the dpi result code appliedtime time product applied, in 14-digit utc time 1 9 verifyinvoicedata defines a dictionary for data returned by the verifyinvoice api dictionary verifyinvoicedata { domstring apiresult; }; the following values are supported apiresult verifyinvoice api result dictionary in json format this value is json string type data, so please use it by json parsing after you parse this value, you can use it in verifyinvoiceapiresult format at the below 1 10 verifyinvoiceapiresult defines a dictionary for the verifyinvoicedata dictionary 'apiresult' parameter dictionary verifyinvoiceapiresult { domstring cpstatus; domstring? cpresult; domstring appid; domstring invoiceid; }; the following values are supported cpstatus dpi result code returns "100000" on success and other codes on failure cpresult [optional] optional additional message "success" other error message, depending on the dpi result code appid application id invoiceid invoice id that you want to verify whether a purchase was successful 1 11 userpurchasedata defines a dictionary for data returned by the getuserpurchaselist api dictionary userpurchasedata { domstring apiresult; }; the following values are supported apiresult getuserpurchaselist api result dictionary in json format this value is json string type data, so please use it by json parsing after you parse this value, you can use it in getuserpurchaselistapiresult format at the below 1 12 getuserpurchaselistapiresult defines a dictionary for the userpurchasedata dictionary 'apiresult' parameter dictionary getuserpurchaselistapiresult { domstring cpstatus; domstring? cpresult; long totalcount; domstring checkvalue; invoicedetails[]? invoicedetails; }; the following values are supported cpstatus it returns "100000" in success, [errorcode] in failure refer to dpi error code cpresult [optional] optional additional message "eof" last page of the product list "hasnext true" product list has further pages other error message, depending on the dpi result code totalcount total number of invoices checkvalue security check value invoicedetails [optional] optional dictionary in json format 1 13 invoicedetails defines a dictionary for the getuserpurchaselistapiresult dictionary 'invoicedetails' parameter dictionary invoicedetails { long seq; domstring invoiceid; domstring itemid; domstring itemtitle; long itemtype; domstring ordertime; long? period; long price; domstring ordercurrencyid; boolean cancelstatus; boolean appliedstatus; domstring? appliedtime; domstring? limitendtime; domstring? remaintime; purchasesubscriptioninfo? subscriptioninfo; }; the following values are supported seq sequence number 1 ~ totalcount invoiceid invoice id of this purchase history itemid product id itemtitle product name itemtype product type "1" consumable "2" non-consumable "3" limited-period "4" subscription ordertime payment time, in 14-digit utc time period [optional] limited period product duration, in minutes price product price, in "xxxx yy" format ordercurrencyid currency code cancelstatus cancellation status "true" sale canceled "false" sale ongoing appliedstatus product application status "true" applied "false" not applied appliedtime [optional] time product applied, in 14-digit utc time limitendtime [optional] limited period product end time, in 14-digit utc time remaintime [optional] limited period product time remaining, in seconds subscriptioninfo [optional] subscription information mandatory for subscription products 1 14 purchasesubscriptioninfo defines a dictionary for the invoicedetails dictionary 'subscriptioninfo' parameter dictionary purchasesubscriptioninfo { domstring subscriptionid; domstring subsstarttime; domstring subsendtime; domstring subsstatus; }; the following values are supported subscriptionid id of subscription history subsstarttime subscription start time, in 14-digit utc time subsendtime subscription expiry time, in 14-digit utc time subsstatus subscription status "00" active "01" subscription expired "02" canceled by buyer "03" canceled for payment failure "04" canceled by cp "05" canceled by admin 1 15 servicecountryavailabilitydata defines a dictionary for data returned by the getservicecountryavailability api dictionary servicecountryavailabilitydata { domstring apiresult; }; the following values are supported apiresult getservicecountryavailability api result dictionary in json format this value is json string type data, so please use it by json parsing after you parse this value, you can use it in getuserpurchaselistapiresult format at the below 1 16 getservicecountryavailabilityapiresult defines a dictionary for the servicecountryavailabilitydata dictionary 'apiresult' parameter dictionary getservicecountryavailabilityapiresult { domstring cpstatus; domstring? cpresult; countries[]? countryavailability; }; the following values are supported cpstatus it returns "100000" in success, [errorcode] in failure refer to dpi error code cpresult [optional] returns "success" on success countryavailability [optional] list of countries with information of service availability 1 17 countries defines a dictionary for the getservicecountryavailabilityapiresult dictionary 'countryavailability' parameter dictionary countries { domstring countrycode; boolean isbillingsupported; }; the following values are supported countrycode countrycode to check service availability isbillingsupported status "true" service is available "false" service is not available 1 18 cancelsubscriptiondata defines a dictionary for subscription cancellation data returned by the cancelsubscription api dictionary cancelsubscriptiondata { domstring apiresult; }; the following values are supported apiresult cancelsubscription api result dictionary in json format this value is json string type data, so please use it by json parsing after you parse this value, you can use it in cancelsubscriptionapiresult format at the below 1 19 cancelsubscriptionapiresult defines a dictionary for the cancelsubscriptiondata dictionary apiresult parameter dictionary cancelsubscriptionapiresult { domstring cpstatus; domstring? cpresult; domstring invoiceid; domstring? subscanceltime; domstring? subsstatus; }; the following values are supported cpstatus dpi result code returns "100000" on success and other codes on failure cpresult [optional] optional additional message "success" other error message, depending on the dpi result code invoiceid invoice id of subscription that you want to cancel subscanceltime [optional] optional time subscription canceled, in 14-digit utc time subsstatus [optional] optional subscription status "00" active "01" subscription expired "02" canceled by buyer "03" canceled for payment failure "04" canceled by cp "05" canceled by admin 1 20 showregisterpromotionalcodedata this defines data set that is coming from showregisterpromotionalcode api dictionary showregisterpromotionalcodedata { domstring opendeeplinkresult; domstring opendeeplinkdetail; }; the following values are supported opendeeplinkresult it returns "success" in success, "fail" in failure opendeeplinkdetail it returns the detail information of coupon or gift card it is a dictionary in json format, so you have to parse it to use for more information, please refer to "promotionalcodedetail" at the below 1 21 promotionalcodedetail this defines data set of promotionalcodedetail parameter that contains showregisterpromotionalcodedata dictionary dictionary promotionalcodedetail { domstring appliedcouponcount; domstring[] appliedcouponlist; domstring registedbenefitcount; domstring[] registedbenefitlist; }; the following values are supported appliedcouponcount it returns the number of applied coupon count appliedcouponlist it returns the list of applied coupon registedbenefitcount it returns the number of benefit registedbenefitlist it returns the list of benefit code 1 22 showregistercreditcarddata this defines data set that is coming from showregistercreditcard api dictionary showregistercreditcarddata { domstring opendeeplinkresult; domstring? opendeeplinkdetail; }; the following values are supported opendeeplinkresult it returns "success" in success, "fail" in failure opendeeplinkdetail [optional] it is optional and not used now 1 23 showpurchasehistorydata this defines data set that is coming from showpurchaseshistory api dictionary showpurchasehistorydata { domstring opendeeplinkresult; domstring opendeeplinkdetail; }; the following values are supported opendeeplinkresult it returns "success" in success, "fail" in failure opendeeplinkdetail it returns the detail information of refund or cancel it is a dictionary in json format, so you have to parse it to use for more information, please refer to "purchasehistorydetail" at the below 1 24 purchasehistorydetail this defines data set of purchasehistorydetail parameter that contains showpurchasehistorydata dictionary dictionary purchasehistorydetail { domstring invoicerefundcount; domstring[] invoicerefundlist; domstring subscriptioncancelcount; domstring[] subscriptioncancellist; }; the following values are supported invoicerefundcount it returns the number of product that user make refunded invoicerefundlist it returns array that contains the list of refunded invoice id subscriptioncancelcount it returns the number of subscription product that user make cancelled subscriptioncancellist it returns array that contains the list of cancelled subscription 1 25 serviceavailabledata defines a dictionary for data returned by the isserviceavailable api dictionary serviceavailabledata { domstring apiresult; }; the following values are supported apiresult isserviceavailable api result dictionary in json format this value is json string type data, so please use it by json parsing after you parse this value, you can use it in serviceavailableapiresult format at the below 1 26 serviceavailableapiresult defines a dictionary for the serviceavailabledata dictionary 'apiresult' parameter dictionary serviceavailableapiresult { domstring status; domstring result; domstring serviceyn; }; the following values are supported status returns "100000" on success and other codes on failure result returns "success" on success serviceyn returns "y" if the service is available 2 interfaces 2 1 billingmanagerobject defines a webapi object instance of the tizen samsung product api the webapis billing object enables access to billing api functionality [nointerfaceobject] interface billingmanagerobject { readonly attribute billingmanager billing; }; webapi implements billingmanagerobject; since 2 4 attributes readonly billingmanager billing billing api namespace 2 2 billingmanager provides methods for billing functionalities [nointerfaceobject] interface billingmanager { void buyitem domstring appid, tvservertype servertype, domstring paymentdetails, billingbuydatasuccesscallback onsuccess, optional errorcallback? onerror ; void getproductslist domstring appid, domstring countrycode, domstring pagesize, domstring pagenumber, domstring checkvalue, tvservertype servertype, billingproductslistcallback onsuccess, optional errorcallback? onerror ; void applyinvoice domstring appid, domstring customid, domstring invoiceid, domstring countrycode, tvservertype servertype, billingapplyinvoicecallback onsuccess, optional errorcallback? onerror ; void verifyinvoice domstring appid, domstring customid, domstring invoiceid, domstring countrycode, tvservertype servertype, billingverifyinvoicecallback onsuccess, optional errorcallback? onerror ; void getservicecountryavailability domstring appid, domstring[] countrycodes, domstring checkvalue, tvservertype servertype, billinggetservicecountryavailabilitycallback onsuccess, optional errorcallback? onerror ; void getuserpurchaselist domstring appid, domstring customid, domstring countrycode, domstring pagenumber, domstring checkvalue, tvservertype servertype, billinggetuserpurchaselistcallback onsuccess, optional errorcallback? onerror ; void cancelsubscription domstring appid, domstring invoiceid, domstring customid, domstring countrycode, tvservertype servertype, billingcancelsubscriptioncallback onsuccess, optional errorcallback? onerror ; void isserviceavailable tvservertype servertype, billingisserviceavailablecallback onsuccess, optional errorcallback? onerror ; domstring getversion ; }; methods buyitem enables implementing the samsung checkout client module within the application after authenticating the purchase information through the application, the user can proceed to purchase payment void buyitem domstring appid, tvservertype servertype, domstring paymentdetails, billingbuydatasuccesscallback onsuccess, optional errorcallback? onerror ; product tv privilege level public privilege http //developer samsung com/privilege/billing parameters appid application id servertype billing server type paymentdetails payment parameters orderitemid[mandatory]/ordertitle[mandatory]/ordertotal[mandatory]/ordercurrencyid[mandatory]/orderid[optional]/ordercustomid[mandatory] onsuccess returns "payresult" and "paydetail" if there is no internal error occurs until client to server data communication payresult, can still contains error when billing server confirms that the given parameters does not have expected value or have problem while processing it paydetail, can have additional data when it's returned, such as invoiceid please refer to the development guide of "buyitem" for details onerror [optional][nullable] optional callback method to invoke if an internal error occurs before the client to server data communication securityerror, if the application does not have the privilege to call this method unknownerror, if other error occur, such as internal error or "billing client already running" error exceptions webapiexception with error type typemismatcherror, if any of input parameter is not compatible with its expected type with error type invalidvalueserror, if servertype contains an invalid value since 2 4 code example var strappid = ""; var struid = webapis sso getloginuid ; var paymentdetails = new object ; paymentdetails orderitemid="pid_2_consum_cupn"; paymentdetails ordertitle="hello consum us coupon"; paymentdetails ordertotal="2"; paymentdetails ordercurrencyid="usd"; paymentdetails ordercustomid=struid; var stringifyresult = json stringify paymentdetails ; var onsuccess = function data {}; var onerror = function error {}; webapis billing buyitem strappid, "dev", stringifyresult, onsuccess, onerror ; getproductslist retrieves the list of products registered on the billing dpi server void getproductslist domstring appid, domstring countrycode, domstring pagesize, domstring pagenumber, domstring checkvalue, tvservertype servertype, billingproductslistcallback onsuccess, optional errorcallback? onerror ; product tv privilege level public privilege http //developer samsung com/privilege/billing parameters appid application id countrycode tv country code pagesize number of products retrieved per page maximum 100 pagenumber requested page number 1 ~ n checkvalue security check value required parameters = "appid" + "countrycode" the check value is used by the dpi service to verify api requests it is a base64 hash generated by applying the hmac sha256 algorithm on a concatenated string of parameters using the dpi security key you can see the example how to generate checkvalue from the following code example you can use any open library to generate the hmac sha256 hash the following example uses the cryptojs library servertype billing server type onsuccess returns the product list if there is no internal error occurs until client to server data communication apiresult, can still contains error when billing server confirms that the given parameters does not have expected value or have problem while processing it when cpstatus value from apiresult is "100000", it means server communication is done properly and other values are valid in returns onerror [optional][nullable] optional callback method to invoke if an internal error occurs before the client to server data communication securityerror, if the application does not have the privilege to call this method unknownerror, if any other error occurs exceptions webapiexception with error type typemismatcherror, if any of input parameter is not compatible with its expected type with error type invalidvalueserror, if servertype contains an invalid value since 4 0 code example var strsecuritykey = ""; // the dpi security key is issued at the dpi portal var strappid = ""; var strcountrycode = webapis productinfo getsystemconfig webapis productinfo productinfoconfigkey config_key_service_country ; var reqparams = strappid + strcountrycode; var hash = cryptojs hmacsha256 reqparams, strsecuritykey ; var strcheckvalue = cryptojs enc base64 stringify hash ; var onsuccess = function data {}; var onerror = function error {}; webapis billing getproductslist strappid, strcountrycode, "100", "1", strcheckvalue, "dev", onsuccess, onerror ; applyinvoice updates the apply status of purchase item to dpi server void applyinvoice domstring appid, domstring customid, domstring invoiceid, domstring countrycode, tvservertype servertype, billingapplyinvoicecallback onsuccess, optional errorcallback? onerror ; product tv privilege level public privilege http //developer samsung com/privilege/billing parameters appid application id customid same value as "ordercustomid" parameter for the buyitem api samsung account uid invoiceid invoice id of purchased item that you want to update apply status countrycode tv country code servertype billing server type onsuccess returns purchase apply status if there is no internal error occurs until client to server data communication apiresult, can still contains error when billing server confirms that the given parameters does not have expected value or have problem while processing it when cpstatus value from apiresult is "100000", it means server communication is done properly and other values are valid in returns onerror [optional][nullable] optional callback method to invoke if an internal error occurs before the client to server data communication securityerror, if the application does not have the privilege to call this method unknownerror, if any other error occurs exceptions webapiexception with error type typemismatcherror, if any of input parameter is not compatible with its expected type with error type invalidvalueserror, if servertype contains an invalid value since 4 0 code example var strappid = ""; var struid = webapis sso getloginuid ; var invoiceid = ""; // issued by getproductslist var strcountrycode = webapis productinfo getsystemconfig webapis productinfo productinfoconfigkey config_key_service_country ; var onsuccess = function data {}; var onerror = function error {}; webapis billing applyinvoice strappid, struid, invoiceid, strcountrycode, "dev", onsuccess, onerror ; verifyinvoice checks whether a purchase, corresponding to a specific "invoiceid", was successful void verifyinvoice domstring appid, domstring customid, domstring invoiceid, domstring countrycode, tvservertype servertype, billingverifyinvoicecallback onsuccess, optional errorcallback? onerror ; product tv privilege level public privilege http //developer samsung com/privilege/billing parameters appid application id customid same value as "ordercustomid" parameter for the buyitem api samsung account uid invoiceid invoice id that you want to verify whether a purchase was successful countrycode tv country code servertype billing server type onsuccess returns the payment status if there is no internal error occurs until client to server data communication apiresult, can still contains error when billing server confirms that the given parameters does not have expected value or have problem while processing it when cpstatus value from apiresult is "100000", it means server communication is done properly and other values are valid in returns onerror [optional][nullable] optional callback method to invoke if an internal error occurs before the client to server data communication securityerror, if the application does not have the privilege to call this method unknownerror, if any other error occurs exceptions webapiexception with error type typemismatcherror, if any of input parameter is not compatible with its expected type with error type invalidvalueserror, if servertype contains an invalid value since 4 0 code example var strappid = ""; var struid = webapis sso getloginuid ; var invoiceid = ""; // issued by getproductslist var strcountrycode = webapis productinfo getsystemconfig webapis productinfo productinfoconfigkey config_key_service_country ; var onsuccess = function data {}; var onerror = function error {}; webapis billing verifyinvoice strappid, struid, invoiceid, strcountrycode, "dev", onsuccess, onerror ; getservicecountryavailability get service country availability for samsung checkout void getservicecountryavailability domstring appid, domstring[] countrycodes, domstring checkvalue, tvservertype servertype, billinggetservicecountryavailabilitycallback onsuccess, optional errorcallback? onerror ; product tv privilege level public privilege http //developer samsung com/privilege/billing parameters appid application id countrycodes to check multiple countrycodes available add as array, only uppercase allowed ex countrycodes=["de","us","kr"] checkvalue security check value required parameters = "appid" + "countrycodes" the check value is used by the dpi service to verify api requests it is a base64 hash generated by applying the hmac sha256 algorithm on a concatenated string of parameters using the dpi security key you can see the example how to generate checkvalue from the following code example you can use any open library to generate the hmac sha256 hash the following example uses the cryptojs library servertype billing server type onsuccess returns the service availability status of each country if there is no internal error occurs until client to server data communication apiresult, can still contains error when billing server confirms that the given parameters does not have expected value or have problem while processing it when cpstatus value from apiresult is "100000", it means server communication is done properly and other values are valid in returns onerror [optional][nullable] optional callback method to invoke if an internal error occurs before the client to server data communication securityerror, if the application does not have the privilege to call this method unknownerror, if any other error occurs exceptions webapiexception with error type typemismatcherror, if any of input parameter is not compatible with its expected type with error type invalidvalueserror, if servertype contains an invalid value since 5 5 code example var strsecuritykey = ""; // the dpi security key is issued at the dpi portal var strappid = ""; var countrycodes = ["de","us","kr"]; var reqparams = strappid + "deuskr"; var hash = cryptojs hmacsha256 reqparams, strsecuritykey ; var strcheckvalue = cryptojs enc base64 stringify hash ; var onsuccess = function data {}; var onerror = function error {}; webapis billing getservicecountryavailability strappid, countrycodes, strcheckvalue, "dev", onsuccess, onerror ; getuserpurchaselist retrieves the user's purchase list void getuserpurchaselist domstring appid, domstring customid, domstring countrycode, domstring pagenumber, domstring checkvalue, tvservertype servertype, billinggetuserpurchaselistcallback onsuccess, optional errorcallback? onerror ; product tv privilege level public privilege http //developer samsung com/privilege/billing parameters appid application id customid same value as "ordercustomid" parameter for the buyitem api samsung account uid countrycode tv country code pagenumber requested page number 1 ~ n checkvalue security check value required parameters = "appid" + "customid" + "countrycode" + "itemtype" + "pagenumber" itemtype, must use 2 as value "all items" the check value is used by the dpi service to verify api requests it is a base64 hash generated by applying the hmac sha256 algorithm on a concatenated string of parameters using the dpi security key you can see the example how to generate checkvalue from the following code example you can use any open library to generate the hmac sha256 hash the following example uses the cryptojs library servertype billing server type onsuccess returns the purchase list if there is no internal error occurs until client to server data communication apiresult, can still contains error when billing server confirms that the given parameters does not have expected value or have problem while processing it when cpstatus value from apiresult is "100000", it means server communication is done properly and other values are valid in returns onerror [optional][nullable] optional callback method to invoke if an internal error occurs before the client to server data communication securityerror, if the application does not have the privilege to call this method unknownerror, if any other error occurs exceptions webapiexception with error type typemismatcherror, if any of input parameter is not compatible with its expected type with error type invalidvalueserror, if servertype contains an invalid value since 4 0 code example var strsecuritykey = ""; // the dpi security key is issued at the dpi portal var strappid = ""; var struid = webapis sso getloginuid ; var strcountrycode = webapis productinfo getsystemconfig webapis productinfo productinfoconfigkey config_key_service_country ; var strpagenumber = "1"; var reqparams = strappid + struid + strcountrycode + "2" + strpagenumber; var hash = cryptojs hmacsha256 reqparams, strsecuritykey ; var strcheckvalue = cryptojs enc base64 stringify hash ; var onsuccess = function data {}; var onerror = function error {}; webapis billing getuserpurchaselist strappid, struid, strcountrycode, strpagenumber, strcheckvalue, "dev", onsuccess, onerror ; cancelsubscription cancels a subscription product void cancelsubscription domstring appid, domstring invoiceid, domstring customid, domstring countrycode, tvservertype servertype, billingcancelsubscriptioncallback onsuccess, optional errorcallback? onerror ; product tv privilege level public privilege http //developer samsung com/privilege/billing parameters appid application id invoiceid invoice id of subscription that you want to cancel customid same value as "ordercustomid" parameter for the buyitem api samsung account uid countrycode tv country code servertype billing server type onsuccess returns the subscription cancellation status if there is no internal error occurs until client to server data communication apiresult, can still contains error when billing server confirms that the given parameters does not have expected value or have problem while processing it when cpstatus value from apiresult is "100000", it means server communication is done properly and other values are valid in returns onerror [optional][nullable] optional callback method to invoke if an error occurs before the client to server data communication securityerror, if the application does not have the privilege to call this method unknownerror, if any other error occurs exceptions webapiexception with error type typemismatcherror, if any of input parameter is not compatible with its expected type with error type invalidvalueserror, if servertype contains an invalid value since 4 0 code example var strappid = ""; var struid = webapis sso getloginuid ; var invoiceid = ""; // issued by getproductslist var strcountrycode = webapis productinfo getsystemconfig webapis productinfo productinfoconfigkey config_key_service_country ; var onsuccess = function data {}; var onerror = function error {}; webapis billing cancelsubscription strappid, invoiceid, struid , strcountrycode , "dev", onsuccess, onerror ; isserviceavailable checks whether the billing server is available however, this api will be replaced by getservicecountryavailability after deprecation void isserviceavailable tvservertype servertype, billingisserviceavailablecallback onsuccess, optional errorcallback? onerror ; product tv privilege level public privilege http //developer samsung com/privilege/billing parameters servertype billing server onsuccess returns the server availability onerror [optional][nullable] optional callback method to invoke if an internal error occurs before the client to server data communication securityerror, if the application does not have the privilege to call this method unknownerror, if any other error occurs exceptions webapiexception with error type typemismatcherror, if any of input parameter is not compatible with its expected type with error type invalidvalueserror, if any input parameter contains an invalid value since 4 0 deprecated 5 5 code example var onsuccess = function data {}; var onerror = function error {}; webapis billing isserviceavailable "dev", onsuccess, onerror getversion retrieves the billing api version domstring getversion ; product tv privilege level public privilege http //developer samsung com/privilege/billing return value domstring billing api version exceptions webapiexception with error type securityerror, if the application does not have the privilege to call this method with error type unknownerror, for any other error since 4 0 code example var version = webapis billing getversion ; 2 3 billingbuydatasuccesscallback defines the payment success callback [callback = functiononly, nointerfaceobject] interface billingbuydatasuccesscallback { void onsuccess billingbuydata data ; }; methods onsuccess callback method returning the payment status void onsuccess billingbuydata data ; privilege level public privilege http //developer samsung com/privilege/billing parameters data payment status code example void onsuccess data { if data payresult == 'success' { // implement success logic } else { // implement cancel or fail logic } } 2 4 billingbuydata defines the payment result and information [nointerfaceobject] interface billingbuydata { attribute domstring payresult; attribute domstring paydetail; }; attributes domstring payresult payment result domstring paydetail payment information it is same with paymentdetails param of buyitem 2 5 billingproductslistcallback defines the product list success callback [callback = functiononly, nointerfaceobject] interface billingproductslistcallback { void onsuccess productslistdata data ; }; methods onsuccess callback method returning the product list request status void onsuccess productslistdata data ; privilege level public privilege http //developer samsung com/privilege/billing parameters data it includes getproductlist api result but you can't use it as it is you have to parse it as json format data code example void onsuccess data { var resproductslist = json parse data apiresult ; if resproductslist cpstatus == "100000" { // implement success logic } else { // implement cancel or fail logic } } 2 6 billingapplyinvoicecallback defines the apply invoice success callback [callback = functiononly, nointerfaceobject] interface billingapplyinvoicecallback { void onsuccess applyinvoicedata data ; }; methods onsuccess callback method returning the apply invoice request status void onsuccess applyinvoicedata data ; privilege level public privilege http //developer samsung com/privilege/billing parameters data it includes applyinvoice api result but you can't use it as it is you have to parse it as json format data code example void onsuccess data { resapplyproduct = json parse data apiresult ; if resapplyproduct cpstatus == "100000" { // implement success logic } else { // implement cancel or fail logic } } 2 7 billingverifyinvoicecallback defines the payment verification success callback [callback = functiononly, nointerfaceobject] interface billingverifyinvoicecallback { void onsuccess verifyinvoicedata data ; }; methods onsuccess callback method returning the payment verification request status void onsuccess verifyinvoicedata data ; privilege level public privilege http //developer samsung com/privilege/billing parameters data it includes verifyinvoice api result but you can't use it as it is you have to parse it as json format data code example void onsuccess data { resverifypurchase = json parse data apiresult ; if resverifypurchase cpstatus == "100000" { // implement success logic } else { // implement cancel or fail logic } } 2 8 billinggetuserpurchaselistcallback defines the purchase history success callback [callback = functiononly, nointerfaceobject] interface billinggetuserpurchaselistcallback { void onsuccess userpurchasedata data ; }; methods onsuccess callback method returning the purchase history request status void onsuccess userpurchasedata data ; privilege level public privilege http //developer samsung com/privilege/billing parameters data it includes getuserpurchaselist api result but you can't use it as it is you have to parse it as json format data code example void onsuccess data { respurchaseslist = json parse data apiresult ; if respurchaseslist cpstatus == "100000" { // implement success logic } else { // implement cancel or fail logic } } 2 9 billinggetservicecountryavailabilitycallback defines the get service country availability callback [callback = functiononly, nointerfaceobject] interface billinggetservicecountryavailabilitycallback { void onsuccess servicecountryavailabilitydata data ; }; methods onsuccess callback method returning availability of country list status void onsuccess servicecountryavailabilitydata data ; privilege level public privilege http //developer samsung com/privilege/billing parameters data it includes getservicecountryavailability api result but you can't use it as it is you have to parse it as json format data code example void onsuccess data { resservicecountryavailability = json parse data apiresult ; if resservicecountryavailability cpstatus == "100000" { // implement success logic } else { // implement cancel or fail logic } } 2 10 billingcancelsubscriptioncallback defines the subscription cancel success callback [callback = functiononly, nointerfaceobject] interface billingcancelsubscriptioncallback { void onsuccess cancelsubscriptiondata data ; }; methods onsuccess callback method returning the subscription cancel request status void onsuccess cancelsubscriptiondata data ; privilege level public privilege http //developer samsung com/privilege/billing parameters data it includes cancelsubscription api result but you can't use it as it is you have to parse it as json format data code example void onsuccess data { rescancelsubscription = json parse data apiresult ; if rescancelsubscription cpstatus == "100000" { // implement success logic } else { // implement cancel or fail logic } } 2 11 billingisserviceavailablecallback defines the service availability check success callback [callback = functiononly, nointerfaceobject] interface billingisserviceavailablecallback { void onsuccess serviceavailabledata data ; }; deprecated 5 5 methods onsuccess callback method returning the service availability check status void onsuccess serviceavailabledata data ; privilege level public privilege http //developer samsung com/privilege/billing parameters data it includes isserviceavailable api result but you can't use it as it is you have to parse it as json format data code example void onsuccess data { resjson = json parse data apiresult if resjson serviceyn == "y" { // implement success logic } else { // implement cancel or fail logic } } 3 full webidl module billing { enum tvservertype { "dev", "prd" }; enum historytype { "all", "subscription", "non-subscription" }; dictionary productslistdata { domstring apiresult; }; dictionary productslistapiresult { domstring cpstatus; domstring? cpresult; long totalcount; domstring checkvalue; itemdetails[]? itemdetails; }; dictionary itemdetails { long seq; domstring itemid; domstring itemtitle; long itemtype; long? period; long price; domstring currencyid; productsubscriptioninfo? subscriptioninfo; }; dictionary productsubscriptioninfo { domstring paymentcycleperiod; long paymentcyclefrq; long paymentcycle; }; dictionary applyinvoicedata { domstring apiresult; }; dictionary applyinvoiceapiresult { domstring cpstatus; domstring? cpresult; domstring appliedtime; }; dictionary verifyinvoicedata { domstring apiresult; }; dictionary verifyinvoiceapiresult { domstring cpstatus; domstring? cpresult; domstring appid; domstring invoiceid; }; dictionary userpurchasedata { domstring apiresult; }; dictionary getuserpurchaselistapiresult { domstring cpstatus; domstring? cpresult; long totalcount; domstring checkvalue; invoicedetails[]? invoicedetails; }; dictionary invoicedetails { long seq; domstring invoiceid; domstring itemid; domstring itemtitle; long itemtype; domstring ordertime; long? period; long price; domstring ordercurrencyid; boolean cancelstatus; boolean appliedstatus; domstring? appliedtime; domstring? limitendtime; domstring? remaintime; purchasesubscriptioninfo? subscriptioninfo; }; dictionary purchasesubscriptioninfo { domstring subscriptionid; domstring subsstarttime; domstring subsendtime; domstring subsstatus; }; dictionary servicecountryavailabilitydata { domstring apiresult; }; dictionary getservicecountryavailabilityapiresult { domstring cpstatus; domstring? cpresult; countries[]? countryavailability; }; dictionary countries { domstring countrycode; boolean isbillingsupported; }; dictionary cancelsubscriptiondata { domstring apiresult; }; dictionary cancelsubscriptionapiresult { domstring cpstatus; domstring? cpresult; domstring invoiceid; domstring? subscanceltime; domstring? subsstatus; }; dictionary showregisterpromotionalcodedata { domstring opendeeplinkresult; domstring opendeeplinkdetail; }; dictionary promotionalcodedetail { domstring appliedcouponcount; domstring[] appliedcouponlist; domstring registedbenefitcount; domstring[] registedbenefitlist; }; dictionary showregistercreditcarddata { domstring opendeeplinkresult; domstring? opendeeplinkdetail; }; dictionary showpurchasehistorydata { domstring opendeeplinkresult; domstring opendeeplinkdetail; }; dictionary purchasehistorydetail { domstring invoicerefundcount; domstring[] invoicerefundlist; domstring subscriptioncancelcount; domstring[] subscriptioncancellist; }; dictionary serviceavailabledata { domstring apiresult; }; dictionary serviceavailableapiresult { domstring status; domstring result; domstring serviceyn; }; [nointerfaceobject] interface billingmanagerobject { readonly attribute billingmanager billing; }; webapi implements billingmanagerobject; [nointerfaceobject] interface billingmanager { void buyitem domstring appid, tvservertype servertype, domstring paymentdetails, billingbuydatasuccesscallback onsuccess, optional errorcallback? onerror ; void getproductslist domstring appid, domstring countrycode, domstring pagesize, domstring pagenumber, domstring checkvalue, tvservertype servertype, billingproductslistcallback onsuccess, optional errorcallback? onerror ; void applyinvoice domstring appid, domstring customid, domstring invoiceid, domstring countrycode, tvservertype servertype, billingapplyinvoicecallback onsuccess, optional errorcallback? onerror ; void verifyinvoice domstring appid, domstring customid, domstring invoiceid, domstring countrycode, tvservertype servertype, billingverifyinvoicecallback onsuccess, optional errorcallback? onerror ; void getservicecountryavailability domstring appid, domstring[] countrycodes, domstring checkvalue, tvservertype servertype, billinggetservicecountryavailabilitycallback onsuccess, optional errorcallback? onerror ; void getuserpurchaselist domstring appid, domstring customid, domstring countrycode, domstring pagenumber, domstring checkvalue, tvservertype servertype, billinggetuserpurchaselistcallback onsuccess, optional errorcallback? onerror ; void cancelsubscription domstring appid, domstring invoiceid, domstring customid, domstring countrycode, tvservertype servertype, billingcancelsubscriptioncallback onsuccess, optional errorcallback? onerror ; void isserviceavailable tvservertype servertype, billingisserviceavailablecallback onsuccess, optional errorcallback? onerror ; domstring getversion ; }; [callback = functiononly, nointerfaceobject] interface billingbuydatasuccesscallback { void onsuccess billingbuydata data ; }; [nointerfaceobject] interface billingbuydata { attribute domstring payresult; attribute domstring paydetail; }; [callback = functiononly, nointerfaceobject] interface billingproductslistcallback { void onsuccess productslistdata data ; }; [callback = functiononly, nointerfaceobject] interface billingapplyinvoicecallback { void onsuccess applyinvoicedata data ; }; [callback = functiononly, nointerfaceobject] interface billingverifyinvoicecallback { void onsuccess verifyinvoicedata data ; }; [callback = functiononly, nointerfaceobject] interface billinggetuserpurchaselistcallback { void onsuccess userpurchasedata data ; }; [callback = functiononly, nointerfaceobject] interface billinggetservicecountryavailabilitycallback { void onsuccess servicecountryavailabilitydata data ; }; [callback = functiononly, nointerfaceobject] interface billingcancelsubscriptioncallback { void onsuccess cancelsubscriptiondata data ; }; [callback = functiononly, nointerfaceobject] interface billingisserviceavailablecallback { void onsuccess serviceavailabledata data ; }; };

filesystem api the filesystem api provides access to a device's filesystem the filesystem is represented as an abstract collection of disjointed filesystem virtual root locations, each corresponding to a specific location in the device filesystem the filesystem api exposes the hierarchies below these root locations as autonomous virtual filesystems each virtual root has a string name each file or directory within the virtual filesystem is addressed using a fully-qualified path of the form <root name>/<path> where <rootname> is the name of the virtual root and <path> is the path to the file or directory relative to that root the following virtual roots must be supported images - the location for images videos - the location for videos music - the location for sounds documents - the location for documents downloads - the location for downloaded items camera - the location for the pictures and videos taken by a device supported since tizen 2 3 wgt-package - the location for widget package which is read-only wgt-private - the location for a widget's private storage wgt-private-tmp - the location for a widget's private volatile storage removable_ - the location for external storages the " " suffix is a unique identifier of an external storage to obtain list of available external storages use liststorages the file uri path is also supported to access paths out of virtual root, for example "file ///tmp" can be used as location parameter the implementation must support the use of the following characters in file names letters a-z, a-z digits 0-9 blank space underscore "_" hyphen "-" period " " the implementation may support additional characters in file names, depending on platform support the implementation may forbid the use of additional characters in file names, depending on the platform the use of the path component separator "/" and null character "x00" should not be allowed in file names some other file name and path characteristics are platform-dependent, for example, maximum path length, file name length, case sensitivity, additional character support, etc therefore, it is recommended to avoid any dependency on aspects that cannot be supported across multiple platforms the encoding used for the file path should be utf-16 default for ecmascript string remark in order to access files, a proper privilege has to be defined additionally for accessing only internal storage using this api, a privilege http //tizen org/privilege/mediastorage must be provided, for accessing only external storage using this api, a privilege http //tizen org/privilege/externalstorage must be provided, for accessing internal and external storage using this api, privileges http //tizen org/privilege/mediastorage and http //tizen org/privilege/externalstorage must be provided remark methods, which names end with nonblocking are asynchronous and are executed in background in the order in which they were called corresponding methods without nonblocking at the end are synchronous and will block further instructions execution, until they are finished for more information on the filesystem features, see file system guide since 1 0 summary of interfaces and methods interface method filesystemmanagerobject filesystemmanager filehandle openfile path path, filemode openmode, optional boolean makeparents void createdirectory path path, optional boolean makeparents, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void deletefile path path, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void deletedirectory path path, optional boolean recursive, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void copyfile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void copydirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void movefile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void movedirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void rename path path, domstring newname, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void listdirectory path path, listdirectorysuccesscallback successcallback, optional errorcallback? errorcallback, optional filefilter? filter domstring touri path path boolean isfile path path boolean isdirectory path path boolean pathexists path path domstring getdirname domstring path void getstorage domstring label, filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror void liststorages filesystemstoragearraysuccesscallback onsuccess, optional errorcallback? onerror long addstoragestatechangelistener filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror void removestoragestatechangelistener long watchid filesystemstorage filehandle long long seek long long offset, optional baseseekposition whence void seeknonblocking long long offset, optional seeksuccesscallback? onsuccess, optional errorcallback? onerror, optional baseseekposition whence domstring readstring optional long long? count, optional domstring inputencoding void readstringnonblocking optional readstringsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long count, optional domstring inputencoding long long writestring domstring inputstring, optional domstring outputencoding void writestringnonblocking domstring inputstring, optional writestringsuccesscallback? onsuccess, optional errorcallback? onerror, optional domstring outputencoding blob readblob optional long long size void readblobnonblocking optional readblobsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size void writeblob blob blob void writeblobnonblocking blob blob, optional successcallback? onsuccess, optional errorcallback? onerror uint8array readdata optional long long size void readdatanonblocking optional readdatasuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size void writedata uint8array data void writedatanonblocking uint8array data, optional successcallback? onsuccess, optional errorcallback? onerror void flush void flushnonblocking optional successcallback? onsuccess, optional errorcallback? onerror void sync void syncnonblocking optional successcallback? onsuccess, optional errorcallback? onerror void close void closenonblocking optional successcallback? onsuccess, optional errorcallback? onerror filefilter filesystemstoragearraysuccesscallback void onsuccess filesystemstorage[] storages filesystemstoragesuccesscallback void onsuccess filesystemstorage storage pathsuccesscallback void onsuccess path path seeksuccesscallback void onsuccess long long position readstringsuccesscallback void onsuccess domstring string writestringsuccesscallback void onsuccess long long bytescount readblobsuccesscallback void onsuccess blob blob readdatasuccesscallback void onsuccess uint8array data listdirectorysuccesscallback void onsuccess domstring[] names, path path 1 type definitions 1 1 path string, which points to file or directory typedef domstring path; since 5 0 in methods available since tizen 5 0, checking or accessing files or directories may be granted only through a valid path paths may contain one of the supported virtual roots the valid path pattern is explained on the top of the page 1 2 filemode specifies the file mode when it is opened enum filemode { "a", "r", "rw", "rwo", "w" }; since 1 0 the file modes defined by this enumerator are a - append access r - read-only access rw - read and write access rwo - read and write access original file content are deleted w - write access remark rwo mode is supported since tizen 5 0 it will not be recognized by deprecated functions 1 3 filesystemstoragetype specifies the type of storage enum filesystemstoragetype { "internal", "external" }; since 1 0 internal - internal storage is a storage that cannot be removed, such as a flash memory external - external storage is removable storage, such as a usb drive or a memory card 1 4 filesystemstoragestate specifies the state of the storage enum filesystemstoragestate { "mounted", "removed", "unmountable" }; since 1 0 mounted - the device is mounted and can be browsed removed - the device has been removed this states applies only to external drives unmountable - the device cannot be mounted due to an error 1 5 blob this is a blob object defined in w3c file api see the blob interface typedef blob blob; since 5 0 1 6 baseseekposition specifies starting point for seek operation enum baseseekposition { "begin", "current", "end" }; since 5 0 begin - beginning of the file current - current position of file indicator end - end of the file 2 interfaces 2 1 filesystemmanagerobject the filesystemmanagerobject interface defines what is instantiated by the tizen object [nointerfaceobject] interface filesystemmanagerobject { readonly attribute filesystemmanager filesystem; }; tizen implements filesystemmanagerobject; since 1 0 there is a tizen filesystem object that allows accessing the functionality of the filesystem api attributes readonly filesystemmanager filesystem object representing a filesystem since 1 0 2 2 filesystemmanager the filesystemmanager interface provides access to the filesystem api [nointerfaceobject] interface filesystemmanager { readonly attribute long maxnamelength; readonly attribute long maxpathlength; filehandle openfile path path, filemode openmode, optional boolean makeparents raises webapiexception ; void createdirectory path path, optional boolean makeparents, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void deletefile path path, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void deletedirectory path path, optional boolean recursive, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void copyfile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void copydirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void movefile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void movedirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void rename path path, domstring newname, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void listdirectory path path, listdirectorysuccesscallback successcallback, optional errorcallback? errorcallback, optional filefilter? filter raises webapiexception ; domstring touri path path raises webapiexception ; boolean isfile path path raises webapiexception ; boolean isdirectory path path raises webapiexception ; boolean pathexists path path raises webapiexception ; domstring getdirname domstring path ; void resolve domstring location, filesuccesscallback onsuccess, optional errorcallback? onerror, optional filemode? mode raises webapiexception ; void getstorage domstring label, filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; void liststorages filesystemstoragearraysuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; long addstoragestatechangelistener filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; void removestoragestatechangelistener long watchid raises webapiexception ; }; since 1 0 this manager interface exposes the filesystem base api and provides functionalities, such as determining root and default locations, resolving a given location into a file handle and registering filesystem listeners for filesystem events attributes readonly long maxnamelength the maximum file or directory name length for the current platform since 5 0 code example console log "the maximum name length is " + tizen filesystem maxnamelength ; output example the maximum name length is 255 readonly long maxpathlength the maximum path length limit for the current platform since 1 0 code example console log "the maximum path length is " + tizen filesystem maxpathlength ; output example the maximum path length is 4096 methods openfile opens a file or creates a file pointed by path filehandle openfile path path, filemode openmode, optional boolean makeparents ; since 5 0 if the operation succeeds, a file handle to the newly created or opened file is returned, otherwise an exception is thrown following file open modes are supported a - append mode file position indicator is always set to the first position after the last character of the file and cannot be modified with seek operations write operations always append content to the end of the file original file content are not modified read operations cannot be performed if the file does not exist, it is created r - read mode file position indicator is initially set to the beginning of the file and may be changed with seek operations write operations cannot be performed original file content may be read in this mode if the file does not exist, notfounderror is thrown rw - read and write mode file position indicator is initially set to the beginning of the file and may be changed with seek operations original file content may be read or modified in this mode if the file does not exist, notfounderror will be thrown rwo - read and write mode, overwriting existing file content file position indicator is initially set to the beginning of the file read and write operations may be performed original file content are deleted before opening the file if the file does not exist, it is created w - write mode file position indicator is initially set to the beginning of the file and may be changed with seek operations read operations cannot be performed original file content are deleted before opening the file if the file does not exist, it is created privilege level public privilege http //tizen org/privilege/filesystem read privilege http //tizen org/privilege/filesystem write remark write permission is needed, when file is opened in modes a, rw, rwo and w read permission is needed, when file is opened in modes r, rw and rwo parameters path path to the file openmode mode in which the file is to be opened makeparents [optional] flag indicating whether lacking directories should be created for instance, if method is invoked with parameter path equal to documents/path/to/dir/file ext and there is no directory "path" in "documents" virtual root, directories "path", "to" and "dir" will be created, as well as the new file "file ext" by default, makeparents is equal to true its value is ignored, when openmode is r or rw return value filehandle object representing open file exceptions webapiexception with error type ioerror, if a file is not available for open or any other io error occurs with error type notfounderror, if the path does not point to an existing file with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; console log "file opened for writing" ; filehandlewrite writestring "lorem ipsum dolor sit amet " ; console log "string has been written to the file" ; filehandlewrite close ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; console log "file opened for reading" ; var filecontent = filehandleread readstring ; console log "file content " + filecontent ; filehandleread close ; output example file opened for writing string has been written to the file file opened for reading file content lorem ipsum dolor sit amet createdirectory creates directory pointed by path void createdirectory path path, optional boolean makeparents, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful directory creation invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if any of the input/output error occurs notfounderror, if directory given in path does not exist and makeparents is set to false privilege level public privilege http //tizen org/privilege/filesystem write parameters path path to directory to create makeparents [optional] flag indicating whether lacking directories should be created for instance, if method is invoked with parameter path equal to documents/path/to/dir and there is no directory "path" in "documents" virtual root, directories "path", "to" and "dir" will be created by default, makeparents is equal to true successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during directory creation " + error message ; } function successcallback path { console log "the directory has been created, path to created directory " + path ; /* directory can now be accessed */ } try { tizen filesystem createdirectory "documents/foo_dir/bar_dir", true, successcallback, errorcallback ; } catch error { console log "directory cannot be created " + error message ; } output example the directory has been created, path to created directory documents/foo_dir/bar_dir deletefile deletes file pointed by path void deletefile path path, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful file deletion invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if any of the input/output error occurs notfounderror, if the path does not point to an existing file privilege level public privilege http //tizen org/privilege/filesystem write parameters path path to file successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during file deletion " + error message ; } function successcallback path { console log "the file has been deleted, path to the parent of deleted file " + path ; } try { tizen filesystem deletefile "documents/foo", successcallback, errorcallback ; } catch error { console log "file cannot be deleted " + error message ; } output example the file has been deleted, path to the parent of deleted file documents deletedirectory deletes directory or directory tree under the current directory pointed by path void deletedirectory path path, optional boolean recursive, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful directory deletion invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if a directory is not empty and recursive is equal to false notfounderror, if the path does not point to an existing directory privilege level public privilege http //tizen org/privilege/filesystem write parameters path a path to directory recursive [optional] flag indicating whether the deletion is recursive or not if recursive is set to true the method will delete content of a given directory recursively otherwise, the method succeeds only if the directory is empty, on other cases errorcallback is called by default, recursive is equal to true successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during directory deletion " + error message ; } function successcallback path { console log "the directory has been deleted, path to the parent of deleted directory " + path ; } try { tizen filesystem deletedirectory "documents/foo_dir", true, successcallback, errorcallback ; } catch error { console log "directory cannot be deleted " + error message ; } output example the directory has been deleted, path to the parent of deleted directory documents copyfile copies file from location pointed by sourcepath to destinationpath void copyfile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful file copying invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if any of the input/output error occurs notfounderror, if the sourcepath does not point to an existing file privilege level public privilege http //tizen org/privilege/filesystem read privilege http //tizen org/privilege/filesystem write parameters sourcepath path to file destinationpath path for copied file the path must consist of path to an existing directory concatenated with '/' and the name of new file overwrite [optional] flag indicating whether to overwrite an existing file if overwrite is set to true and file pointed by destinationpath already exists, the method will overwrite the file otherwise, if a file with conflicting name already exists errorcallback is called by default, overwrite is equal to false successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if any of the input parameters contains an invalid value for example, the sourcepath or the destinationpath is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during copy operation " + error message ; } function successcallback path { console log "the file has been copied, path to copied file " + path ; /* file copy can now be accessed */ } try { tizen filesystem copyfile "documents/foo", "documents/bar", true, successcallback, errorcallback ; } catch error { console log "copy operation cannot be performed " + error message ; } output example the file has been copied, path to copied file documents/bar copydirectory recursively copies directory pointed by sourcepath to destinationpath void copydirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 the method merges content of the directory pointed by sourcepath with content of the directory pointed by destinationpath, if exists if the directory pointed by destinationpath does not exist, it is created successful directory copying invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if a directory with conflicting name already exists and overwrite is equal to false or any of the input/output error occurs notfounderror, if the sourcepath does not point to an existing directory privilege level public privilege http //tizen org/privilege/filesystem read privilege http //tizen org/privilege/filesystem write parameters sourcepath path to directory destinationpath path for copied directory the path must consist of path to an existing directory concatenated with '/' and the name of destination directory overwrite [optional] flag indicating whether to overwrite existing content if overwrite is equal to true, the file or directory with conflicting name will be overwritten otherwise, errorcallback will be called with ioerror by default, overwrite is equal to false successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if any of the input parameters contains an invalid value for example, the sourcepath or the destinationpath is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during copy operation " + error message ; } function successcallback path { console log "the directory has been copied, path to copied directory " + path ; /* directory copy can now be accessed */ } try { tizen filesystem copydirectory "documents/foo_dir", "documents/bar_dir", true, successcallback, errorcallback ; } catch error { console log "copy operation cannot be performed " + error message ; } output example the directory has been copied, path to copied directory documents/bar_dir code example function errorcallback error { console log "an error occurred " + error message ; } function createfoodircallback { tizen filesystem createdirectory "documents/foo_dir/dir_2", true, createfilecallback, errorcallback ; } function listcallback files, path { console log "found inside " + path + " directory " ; for var i = 0; i < files length; i++ { console log files[i] ; } } function successcallback path { console log "the directory has been created and copied, path to directory " + path ; /* directory 'documents/bar_dir' content is as below */ /* documents/bar_dir/dir_1 */ /* documents/bar_dir/dir_2 */ /* documents/bar_dir/dir_1/file */ tizen filesystem listdirectory "documents/bar_dir", listcallback, errorcallback ; tizen filesystem listdirectory "documents/bar_dir/dir_1", listcallback, errorcallback ; } function createfilecallback { tizen filesystem openfile "documents/foo_dir/dir_1/file", "w" close ; try { tizen filesystem copydirectory "documents/foo_dir", "documents/bar_dir", true, successcallback, errorcallback ; } catch error { console log "copy operation cannot be performed " + error message ; } } tizen filesystem createdirectory "documents/foo_dir/dir_1", true, createfoodircallback, errorcallback ; output example the directory has been created and copied, path to directory documents/bar_dir found inside documents/bar_dir directory dir_1 dir_2 found inside documents/bar_dir/dir_1 directory file movefile moves file pointed by sourcepath to destinationpath void movefile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful file moving invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if a file with conflicting name already exists and overwrite is equal to false or any of the input/output error occurs notfounderror, if the sourcepath or destinationpath does not point to an existing file or directory privilege level public privilege http //tizen org/privilege/filesystem read privilege http //tizen org/privilege/filesystem write parameters sourcepath path to file destinationpath a destination directory path to move the file to overwrite [optional] flag indicating whether to overwrite an existing file if overwrite is set to true and file with the same name in destinationpath already exists, the method will overwrite the file otherwise, if a file with conflicting name already exists errorcallback is called by default, overwrite is equal to false successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if any of the input parameters contains an invalid value for example, the sourcepath or the destinationpath is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during move operation " + error message ; } function successcallback path { console log "the file has been moved, path to moved file " + path ; /* moved file can now be accessed */ } try { tizen filesystem movefile "documents/foo", "documents/foo_dir/", false, successcallback, errorcallback ; } catch error { console log "move operation cannot be performed " + error message ; } output example the file has been moved, path to moved file documents/foo_dir/foo movedirectory recursively moves directory pointed by sourcepath to destinationpath void movedirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 the method merges content of the directory pointed by sourcepath with content of the directory with the same name in destinationpath, if exists successful directory moving invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if a directory with conflicting name already exists and overwrite is equal to false or any of the input/output error occurs notfounderror, if the sourcepath or destinationpath does not point to an existing directory privilege level public privilege http //tizen org/privilege/filesystem read privilege http //tizen org/privilege/filesystem write parameters sourcepath a path to directory destinationpath a destination directory path to move the directory to overwrite [optional] flag indicating whether to overwrite existing content if overwrite is equal to true, the file or directory with conflicting name will be overwritten otherwise, errorcallback will be called with ioerror by default, overwrite is equal to false successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if any of the input parameters contains an invalid value for example, the sourcepath or the destinationpath is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during move operation " + error message ; } function successcallback path { console log "the directory has been moved, path to moved directory " + path ; /* moved directory can now be accessed */ } try { tizen filesystem movedirectory "documents/foo_dir", "documents/bar_dir/", false, successcallback, errorcallback ; } catch error { console log "move operation cannot be performed " + error message ; } output example the directory has been moved, path to moved directory documents/bar_dir/foo_dir rename renames file or directory located in path to name newname void rename path path, domstring newname, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful renaming invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if a file or a directory with conflicting name already exists or any of the input/output error occurs notfounderror, if the path does not point to an existing file or directory privilege level public privilege http //tizen org/privilege/filesystem write parameters path a path to directory or file newname a new name of directory or file successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if the path or newname is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during rename operation " + error message ; } function successcallback path { console log "the file has been renamed, path to renamed file or directory " + path ; } try { tizen filesystem rename "documents/foo", "bar", successcallback, errorcallback ; } catch error { console log "rename operation cannot be performed " + error message ; } output example the file has been renamed, path to renamed file or directory documents/bar listdirectory lists directory content located in path void listdirectory path path, listdirectorysuccesscallback successcallback, optional errorcallback? errorcallback, optional filefilter? filter ; since 5 0 successful listing of directory content invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified if the filter is passed and contains valid values, only those directories or files in the directory that match the filter criteria specified in the filefilter interface are returned in successcallback method if the filter is null or undefined the implementation must return the full list of files in the directory if the directory does not contain any files or directories, or the filter criteria do not match with any files or directories, the successcallback is invoked with an empty array the errorcallback is launched with these error types ioerror, if any of the input/output error occurs notfounderror, if the path does not point to an existing directory privilege level public privilege http //tizen org/privilege/filesystem read parameters path a path to directory successcallback callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs filter [optional] [nullable] filter to restrict the listed files exceptions webapiexception with error type invalidvalueserror, if any of the input parameters contains an invalid value for example, the path is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during directory listing " + error message ; } function successcallback files, path { console log "found directories in " + path + " directory " ; for var i = 0; i < files length; i++ { console log files[i] ; } } try { var start = new date "jan 01 2018 00 00 00" ; tizen filesystem listdirectory "documents/", successcallback, errorcallback, {name "foo_%", isdirectory true, startmodified start} ; } catch error { console log "directory listing cannot be performed " + error message ; } output example found directories in documents/ directory foo_dir_c foo_dir_b foo_dir_d foo_dir_a touri converts path to file uri domstring touri path path ; since 5 0 remark the function does not check if path exists in filesystem parameters path a path to a file or a directory return value domstring file uri for given path exceptions webapiexception with error type invalidvalueserror, if the path is invalid code example var path1 = tizen filesystem touri "documents/directory/file ext" ; var path2 = tizen filesystem touri "/opt/usr/home/owner/content/documents/directory/file ext" ; var path3 = tizen filesystem touri "file ///opt/usr/home/owner/content/documents/directory/file ext" ; /* all above paths point to the same file */ console log path1 ; console log path2 ; console log path3 ; var mmcpath = tizen filesystem touri "removable_sda1/documents/directory/file" ; console log mmcpath ; output example file ///opt/usr/home/owner/content/documents/directory/file ext file ///opt/usr/home/owner/content/documents/directory/file ext file ///opt/usr/home/owner/content/documents/directory/file ext file ///opt/media/usbdrivea1/documents/directory/file isfile checks if given path points to a file boolean isfile path path ; since 5 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters path a path to be tested return value boolean true if path points to a file, false otherwise exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type ioerror, if any of the input/output error occurs with error type notfounderror, if the path does not point to an existing file or directory with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example console log "documents/foo_file is " + tizen filesystem isfile "documents/foo_file" ? "file" "directory" ; output example documents/foo_file is file isdirectory checks if given path points to a directory boolean isdirectory path path ; since 5 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters path a path to be tested return value boolean true if path points to a directory, false otherwise exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type ioerror, if any of the input/output error occurs with error type notfounderror, if the path does not point to an existing file or directory with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example console log "documents/foo_dir is " + tizen filesystem isdirectory "documents/foo_dir" ? "directory" "file" ; output example documents/foo_dir is directory pathexists checks if given path exists boolean pathexists path path ; since 5 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters path a path to be tested return value boolean true if path points to a existing element, false otherwise exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type ioerror, if input/output error occurs with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example console log "documents/foo " + tizen filesystem pathexists "documents/foo" ? "exists" "does not exist" ; output example documents/foo does not exist getdirname returns path to directory for given path domstring getdirname domstring path ; since 5 0 strips trailing '/', then breaks path into two components by last path separator, returns first component remark this function does not check if path is valid or exists in filesystem parameters path path to file or directory return value domstring path to directory for given path code example console log tizen filesystem getdirname "/home/owner/media/documents" ; output example "/home/owner/media" resolve resolves a location to a file handle after validating it deprecated since 5 0 void resolve domstring location, filesuccesscallback onsuccess, optional errorcallback? onerror, optional filemode? mode ; since 1 0 a location can contain a virtual path like "documents/some_file txt" or a file uri like "file ///my_strange_path/some_file png" a location is not allowed to contain the " " or " " directory entries inside its value the list of root locations that must be supported by a compliant implementation are documents - the default folder in which text documents such as pdf, doc are stored by default in a device for example, in some platforms it corresponds to the "my documents" folder images - the default folder in which still images, like pictures in formats including jpg, gif, png, etc , are stored in the device by default for example, in some platforms it corresponds to the "my images" folder music - the default folder in which sound clips in formats including mp3, aac, etc are stored in the device by default for example, in some platforms it corresponds to the "my music" folder videos - the default folder in which video clips in formats including avi, mp4, etc are stored in the device by default for example, in some platforms it corresponds to the "my videos" folder downloads - the default folder in which downloaded files from sources including browser, e-mail client, etc are stored by default in the device for example, in some platforms it corresponds to the "downloads" folder ringtones - the default folder in which ringtones such as mp3, etc are stored in the device camera - the default folder in which pictures and videos taken by a device are stored wgt-package - the read-only folder to which the content of a widget file is extracted wgt-private - the private folder in which a widget stores its information this folder must be accessible only to the same widget and other widgets or applications must not be able to access the stored information wgt-private-tmp - temporary, the private folder in which a widget can store data that is available during a widget execution cycle content of this folder can be removed from this directory when the widget is closed or the web runtime is restarted this folder must be accessible only to the same widget and other widgets or applications must not be able to access it the mode parameter specifies whether the resulting file object has read-only access r access , read and write access rw access , append access a access , or write access w access to the root location containing directory tree permission for the requested access is obtained from the security framework once the resulting file object has access, access is inherited by any other file objects that are derived from this instance without any further reference to the security framework, as noted in descriptions of certain methods of file the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value for example, the mode is w for the read-only virtual roots wgt-package and ringtones notfounderror - if the location input argument does not correspond to a valid location unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read remark camera location is supported since tizen 2 3 if a device does not support camera, notsupportederror will be thrown parameters location location to resolve that can be a virtual path or file uri onsuccess callback method to be invoked when the location has been successfully resolved, passing the newly created file object onerror [optional] [nullable] callback method to be invoked when an error has occurred mode [optional] [nullable] optional value to indicate the file access mode on all files and directories that can be reached from the file object passed to onsuccess default value of this parameter is rw if absent or null exceptions webapiexception with error type notsupportederror, if this feature is not supported e g in the case of "camera" virtual path if the device does not support camera , or if mode has been set to "rwo", which was introduced in tizen version 5 0 with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example tizen filesystem resolve "images", function dir { console log "images are stored in " + dir path ; }, function e { console log "error " + e message ; }, "r" ; getstorage gets information about a storage based on its label for example "mythumbdrive", "internalflash" void getstorage domstring label, filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror ; since 1 0 the onsuccess method receives the data structure as an input argument containing additional information about the drive the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value notfounderror - if no drive was found with the given label unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read parameters label storage label onsuccess callback method to be invoked when the list of storages is available, passing the storage list to the callback onerror [optional] [nullable] callback method to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example function onstorage storage { /* do something */ } function onstorageerror e { console log "storage not found " + e message ; } tizen filesystem getstorage "music", onstorage, onstorageerror ; liststorages lists the available storages both internal and external on a device the onsuccess method receives a list of the data structures as input argument containing additional information about each drive found it can get storages that would have a label named as "internal0", virtual roots images, documents, , "removable1", "removable2" "removable1" label is used to resolve sdcard and "removable2" label is used to resolve usb host, if supported the vfat filesystem used to sdcard filesystem widely is not case-sensitive if you want to handle the file on sdcard, you need to consider case-sensitive filenames are regarded as same name void liststorages filesystemstoragearraysuccesscallback onsuccess, optional errorcallback? onerror ; since 1 0 labels can differ depending on platform implementation the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read parameters onsuccess callback method to be invoked when a list of storage is available and passing the storage list to the callback onerror [optional] [nullable] callback method to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example function alertforcorruptedremovabledrives storages { for var i = 0; i < storages length; i++ { if storages[i] type != "external" continue; if storages[i] state == "unmountable" console log "external drive " + storages[i] label + " is corrupted " ; } } tizen filesystem liststorages alertforcorruptedremovabledrives ; addstoragestatechangelistener adds a listener to subscribe to notifications when a change in storage state occurs long addstoragestatechangelistener filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror ; since 1 0 the most common usage for this method is to watch for any additions and removals of external storages when executed, it returns a subscription identifier that identifies the watch operation after returning the identifier, the watch operation is started asynchronously the onsuccess method will be invoked every time a storage state changes if the attempt fails, the onerror if present will be invoked with the relevant error type the watch operation must continue until the removestoragestatechangelistener method is called with the corresponding subscription identifier privilege level public privilege http //tizen org/privilege/filesystem write parameters onsuccess callback method to be invoked when any change is made to storage state onerror [optional] [nullable] callback method to be invoked when an error occurs during the watch process return value long subscription identifier exceptions webapiexception with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type unknownerror, if any other error occurs code example var watchid; function onstoragestatechanged storage { if storage state == "mounted" console log "storage " + storage label + " was added!" ; } watchid = tizen filesystem addstoragestatechangelistener onstoragestatechanged ; removestoragestatechangelistener removes a listener to unsubscribe from a storage watch operation void removestoragestatechangelistener long watchid ; since 1 0 if the watchid argument is valid and corresponds to a subscription already in place, the watch process will be stopped and no further callbacks will be invoked otherwise, the method call has no effect privilege level public privilege http //tizen org/privilege/filesystem write parameters watchid subscription identifier exceptions webapiexception with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges with error type unknownerror, if any other error occurs code example var watchid; function onstoragestatechanged storage { if storage state == "mounted" console log "storage " + storage label + " was added!" ; tizen filesystem removestoragestatechangelistener watchid ; } watchid = tizen filesystem addstoragestatechangelistener onstoragestatechanged ; 2 3 filesystemstorage the filesystemstorage interface gives additional information about a storage, such as if the device is mounted, if it is a removable drive or not, or the device's name [nointerfaceobject] interface filesystemstorage { readonly attribute domstring label; readonly attribute filesystemstoragetype type; readonly attribute filesystemstoragestate state; }; since 1 0 to retrieve the mount point, the resolve method should be used using the label as argument attributes readonly domstring label the storage name this attribute is used as an input for methods such as getstorage and also used as location parameter for file resolve and filesystemmanager resolve since 1 0 readonly filesystemstoragetype type the storage type as internal or external since 1 0 readonly filesystemstoragestate state the storage state as mounted or not since 1 0 2 4 filehandle object representing file, used for read/write operations [nointerfaceobject] interface filehandle { readonly attribute path path; long long seek long long offset, optional baseseekposition whence raises webapiexception ; void seeknonblocking long long offset, optional seeksuccesscallback? onsuccess, optional errorcallback? onerror, optional baseseekposition whence raises webapiexception ; domstring readstring optional long long? count, optional domstring inputencoding raises webapiexception ; void readstringnonblocking optional readstringsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long count, optional domstring inputencoding raises webapiexception ; long long writestring domstring inputstring, optional domstring outputencoding raises webapiexception ; void writestringnonblocking domstring inputstring, optional writestringsuccesscallback? onsuccess, optional errorcallback? onerror, optional domstring outputencoding raises webapiexception ; blob readblob optional long long size raises webapiexception ; void readblobnonblocking optional readblobsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size raises webapiexception ; void writeblob blob blob raises webapiexception ; void writeblobnonblocking blob blob, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; uint8array readdata optional long long size raises webapiexception ; void readdatanonblocking optional readdatasuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size raises webapiexception ; void writedata uint8array data raises webapiexception ; void writedatanonblocking uint8array data, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void flush raises webapiexception ; void flushnonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void sync raises webapiexception ; void syncnonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void close raises webapiexception ; void closenonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; }; since 5 0 each read or write operation moves position in file forwards to the end of read/written data there is an underlying file position's indicator remark due to multibyte utf-8 encoding, if current file's pointer does not point to beginning of multibyte sequence see utf-16, emoji , using seek combined with utf-8 readstring will result in string starting from valid character incomplete byte sequence at the beginning may be omitted be aware about using seek and write methods together it can result in writing in the middle of multibyte sequence, which can lead to file with corrupted content attributes readonly path path path, as passed to openfile since 5 0 methods seek sets position indicator in file stream to offset long long seek long long offset, optional baseseekposition whence ; since 5 0 note, that current position indicator value, can be obtained by calling seek 0, "current" parameters offset number of bytes to shift the position relative to whence whence [optional] determines position in file stream to which offset is added default value "begin" return value long long file position indicator exceptions webapiexception with error type ioerror, if seek fails or any error related to file handle occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example var datatowrite = new uint8array [11, 21, 31, 44, 55, 66, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedata datatowrite ; filehandlewrite close ; console log "data has been written" ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var firstthreebytes = filehandleread readdata 3 ; console log "first three bytes " + firstthreebytes ; var position = filehandleread seek -3, "end" ; /* moving to position three bytes to the end of file */ var lastthreebytes = filehandleread readdata 3 ; console log "last three bytes " + lastthreebytes ; filehandleread seek 3, "begin" ; /* moving to position at third byte */ var bytesbetween = filehandleread readdata position - 3 ; console log "bytes between " + bytesbetween ; filehandleread close ; output example data has been written first three bytes 11,21,31 last three bytes 71,81,91 bytes between 44,55,66 seeknonblocking sets position indicator in file stream to offset void seeknonblocking long long offset, optional seeksuccesscallback? onsuccess, optional errorcallback? onerror, optional baseseekposition whence ; since 5 0 successful seek operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if any error related to file handle occurs note, that current position indicator value, can be obtained in seeksuccesscallback by calling seeknonblocking 0, "current" seeknonblocking is executed in background and does not block further instructions parameters offset number of bytes to shift the position relative to whence onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs whence [optional] determines position in file stream to which offset is added default value "begin" exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writestringnonblocking "lorem ipsum dolor sit amet ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; /* moving to position 3 bytes to the end of file to alter three dots " " */ filehandlewrite seeknonblocking -3, function new_position { console log "moved to position " + new_position ; }, function error { console log error ; }, "end" ; filehandlewrite writestringnonblocking ", consectetur adipiscing elit ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; /* moving to position 3 bytes to the end of file to alter three dots " " */ filehandlewrite seeknonblocking -3, function new_position { console log "moved to position " + new_position ; }, function error { console log error ; }, "end" ; filehandlewrite writestringnonblocking ", sed do eiusmod ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; /* readstringsuccesscallback should be executed */ filehandleread readstringnonblocking function output { console log "file content " + output ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example number of bytes written 29 moved to position 26 number of bytes written 32 moved to position 55 number of bytes written 19 file handle closed file content lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod file handle closed readstring reads file content as string domstring readstring optional long long? count, optional domstring inputencoding ; since 5 0 sets file handle position indicator at the end of read data reads given number of characters remark resulting string can have length larger than count, due to possible utf-16 surrogate pairs in it string length in javascript is counted in utf-16 encoding, so for example string containing one emoji surrogate of two utf-16 character will have length of two parameters count [optional] [nullable] number of characters to read from file if none is given, method attempts to read whole file inputencoding [optional] default value "utf-8" encoding to use for read operation on the file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin-1 encoding return value domstring string with data read from file exceptions webapiexception with error type invalidvalueserror if given count exceeds maximum value supported by the device with error type ioerror, if read fails or any error related to file handle occurs with error type notsupportederror, if the given encoding is not supported with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; console log "file opened for writing" ; filehandlewrite writestring "lorem ipsum dolor sit amet " ; console log "string has been written to the file" ; filehandlewrite close ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; console log "file opened for reading" ; var filecontent = filehandleread readstring ; console log "file content " + filecontent ; filehandleread close ; output example file opened for writing string has been written to the file file opened for reading file content lorem ipsum dolor sit amet readstringnonblocking reads file content as string void readstringnonblocking optional readstringsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long count, optional domstring inputencoding ; since 5 0 reads given number of characters sets file handle position indicator at the end of read data readstringnonblocking is executed in background and does not block further instructions successful read operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if read fails or any error related to file handle occurs parameters onsuccess [optional] [nullable] callback function with read data from file to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs count [optional] number of characters to read from file if none is given, method attempts to read whole file inputencoding [optional] default value "utf-8" encoding to use for read operation on the file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin-1 encoding exceptions webapiexception with error type invalidvalueserror if given count exceeds maximum value supported by the device with error type notsupportederror, if the given encoding is not supported with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; console log "file opened for writing" ; filehandlewrite writestringnonblocking "lorem ipsum dolor sit amet ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; /* readstringsuccesscallback should be executed */ filehandleread readstringnonblocking function output { console log "file content " + output ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example file opened for writing number of bytes written 29 file handle closed file content lorem ipsum dolor sit amet file handle closed writestring writes inputstring content to a file long long writestring domstring inputstring, optional domstring outputencoding ; since 5 0 sets file handle position indicator at the end of written data parameters inputstring string value to be written to a file outputencoding [optional] default value utf-8 encoding to use for write operation on the file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin-1 encoding return value long long number of bytes written can be more than inputstring length for multibyte encodings and will never be less exceptions webapiexception with error type ioerror, if input/output error occurs with error type notsupportederror, if the given encoding is not supported code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; console log "file opened for writing" ; filehandlewrite writestring "lorem ipsum dolor sit amet " ; console log "string has been written to the file" ; filehandlewrite close ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; console log "file opened for reading" ; var filecontent = filehandleread readstring ; console log "file content " + filecontent ; filehandleread close ; output example file opened for writing string has been written to the file file opened for reading file content lorem ipsum dolor sit amet writestringnonblocking writes inputstring content to a file void writestringnonblocking domstring inputstring, optional writestringsuccesscallback? onsuccess, optional errorcallback? onerror, optional domstring outputencoding ; since 5 0 sets file handle position indicator at the end of written data writestringnonblocking is executed in background and does not block further instructions successful write operation invokes successcallback function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if write fails or any error related to file handle occurs parameters inputstring string value to be written to a file onsuccess [optional] [nullable] callback function with a number of bytes written as parameter to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs outputencoding [optional] default value "utf-8" encoding to use for write operation on the file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin-1 encoding exceptions webapiexception with error type notsupportederror, if the given encoding is not supported with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writestringnonblocking "lorem ipsum dolor sit amet ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; /* readstringsuccesscallback should be executed */ filehandleread readstringnonblocking function output { console log "file content " + output ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example number of bytes written 29 file handle closed file content lorem ipsum dolor sit amet file handle closed readblob reads file content as blob blob readblob optional long long size ; since 5 0 sets file handle position indicator at the end of read data parameters size [optional] size in bytes of data to read from file if none is given, method attempts to read whole file return value blob blob object with file content exceptions webapiexception with error type invalidvalueserror if given size exceeds maximum value supported by the device with error type ioerror, if read fails or any error related to file handle occurs code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; var b = new blob ["lorem ipsum dolor sit amet "], {type "text/plain"} ; filehandlewrite writeblob b ; filehandlewrite close ; console log "blob content has been written to file" ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var filecontentinblob = filehandleread readblob ; filehandleread close ; const reader = new filereader ; /* event fires after the blob has been read/loaded */ reader onloadend = function content { const text = content srcelement result; console log "file content " + text ; }; /* starts reading the blob as text */ reader readastext filecontentinblob ; output example blob content has been written to file file content lorem ipsum dolor sit amet readblobnonblocking reads file content as blob void readblobnonblocking optional readblobsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size ; since 5 0 sets file handle position indicator at the end of read data readblobnonblocking is executed in background and does not block further instructions successful read operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if read fails or any error related to file handle occurs parameters onsuccess [optional] [nullable] callback function with blob object to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs size [optional] [nullable] size in bytes of data to read from file if none is given, method attempts to read whole file exceptions webapiexception with error type invalidvalueserror if given size exceeds maximum value supported by the device with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; var b = new blob ["lorem ipsum dolor sit amet "], {type "text/plain"} ; filehandlewrite writeblobnonblocking b, function { console log "blob content has been written to file" ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; /* creation of a reader capable of extracting blob content */ const reader = new filereader ; /* event fires after the blob has been read/loaded */ reader onloadend = function content { const text = content srcelement result; console log "file content " + text ; }; function readblobcallback filecontentinblob { reader readastext filecontentinblob ; } /* readblobcallback should be executed */ filehandleread readblobnonblocking readblobcallback, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example blob content has been written to file file handle closed file handle closed file content lorem ipsum dolor sit amet writeblob writes blob to file void writeblob blob blob ; since 5 0 sets file handle position indicator at the end of written data parameters blob object of type blob, which content will be written to a file exceptions webapiexception with error type ioerror, if write fails or any error related to file handle occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; var b = new blob ["lorem ipsum dolor sit amet "], {type "text/plain"} ; filehandlewrite writeblob b ; filehandlewrite close ; console log "blob content has been written to file" ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var filecontentinblob = filehandleread readblob ; filehandleread close ; console log "file content has been read from file" ; const reader = new filereader ; /* event fires after the blob has been read/loaded */ reader onloadend = function content { const text = content srcelement result; console log "file content " + text ; }; /* starts reading the blob as text */ reader readastext filecontentinblob ; output example blob content has been written to file file content has been read from file file content lorem ipsum dolor sit amet writeblobnonblocking writes blob to file void writeblobnonblocking blob blob, optional successcallback? onsuccess, optional errorcallback? onerror ; since 5 0 sets file handle position indicator at the end of written data writeblobnonblocking is executed in background and does not block further instructions successful write operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if write fails or any error related to file handle occurs parameters blob object of type blob, which content will be written to a file onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; var b = new blob ["lorem ipsum dolor sit amet "], {type "text/plain"} ; filehandlewrite writeblobnonblocking b, function { console log "blob content has been written to file" ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; /* creation of a reader capable of extracting blob content */ const reader = new filereader ; /* event fires after the blob has been read/loaded */ reader onloadend = function content { const text = content srcelement result; console log "file content " + text ; }; function readblobcallback filecontentinblob { reader readastext filecontentinblob ; } /* readblobcallback should be executed */ filehandleread readblobnonblocking readblobcallback ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example blob content has been written to file file handle closed file handle closed file content lorem ipsum dolor sit amet readdata reads file content as binary data uint8array readdata optional long long size ; since 5 0 can be used in combination with atob or btoa functions sets file handle position indicator at the end of read data parameters size [optional] size in bytes of data to read from file if none is given, method attempts to read whole file return value uint8array read data as uint8array exceptions webapiexception with error type invalidvalueserror if given size exceeds maximum value supported by the device with error type ioerror, if read fails or any error related to file handle occurs code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedata datatowrite ; filehandlewrite close ; console log "data has been written" ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var filecontentinuint8array = filehandleread readdata ; filehandleread close ; console log "data read from file " + filecontentinuint8array ; output example data has been written data read from file 11,21,31,71,81,91 readdatanonblocking reads file content as binary data void readdatanonblocking optional readdatasuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size ; since 5 0 can be used in combination with atob or btoa functions sets file handle position indicator at the end of read data readdatanonblocking is executed in background and does not block further instructions successful read operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if read fails or any error related to file handle occurs parameters onsuccess [optional] [nullable] callback function with read data from file to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs size [optional] [nullable] size in bytes of data to read from file if none is given, method attempts to read whole file exceptions webapiexception with error type invalidvalueserror if given size exceeds maximum value supported by the device with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedatanonblocking datatowrite, function dataread { console log "write done" ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; filehandleread readdatanonblocking function dataread { console log "data read from file " + dataread ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example write done file handle closed data read from file 11,21,31,71,81,91 file handle closed writedata writes binary data to file void writedata uint8array data ; since 5 0 can be used in combination with atob or btoa functions sets file handle position indicator at the end of written data parameters data an array of type uint8array, which content will be written to file as binary data exceptions webapiexception with error type ioerror, if write fails or any error related to file handle occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedata datatowrite ; filehandlewrite close ; console log "data has been written" ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var filecontentinuint8array = filehandleread readdata ; filehandleread close ; console log "data read from file " + filecontentinuint8array ; output example data has been written data read from file 11,21,31,71,81,91 writedatanonblocking writes binary data to file void writedatanonblocking uint8array data, optional successcallback? onsuccess, optional errorcallback? onerror ; since 5 0 can be used in combination with atob or btoa functions sets file handle position indicator at the end of written data writedatanonblocking is executed in background and does not block further instructions successful write operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if write fails or any error related to file handle occurs parameters data an array of type uint8array, which content will be written to file as binary data onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedatanonblocking datatowrite, function dataread { console log "write done" ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; filehandleread readdatanonblocking function dataread { console log "data read from file " + dataread ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example write done file handle closed data read from file 11,21,31,71,81,91 file handle closed flush flushes data void flush ; since 5 0 for file handles with permission to write, flush writes any changes made to file content to underlying buffer flush does not ensure that data is written on storage device, it only synchronizes ram with file descriptor to ensure storage synchronization use sync, close or their asynchronous equivalent methods, which guarantee such synchronization exceptions webapiexception with error type ioerror, if flush fails or any error related to file handle occurs code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; var filehandleread = tizen filesystem openfile "documents/file", "r" ; filehandlewrite writestring "lorem ipsum dolor sit amet " ; console log "data has been written to file" ; /* calling flush ensures that content has been written to file descriptor and can be read by any */ /* process */ filehandlewrite flush ; console log "data has been flushed to system file buffer and now can be read" ; var filecontent = filehandleread readstring ; console log "read data " + filecontent ; filehandlewrite close ; filehandleread close ; output example data has been written to file data has been flushed to system file buffer and now can be read read data lorem ipsum dolor sit amet flushnonblocking flushes data void flushnonblocking optional successcallback? onsuccess, optional errorcallback? onerror ; since 5 0 for file handles with permission to write, flush writes any changes made to file content to underlying buffer flush does not ensure that data is written on storage device, it only synchronizes ram with file descriptor to ensure storage synchronization use sync, close or their asynchronous equivalent methods, which guarantee such synchronization successful flushing invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if flush fails or any error related to file handle occurs this method is asynchronous its execution will occur in background and after all previously commissioned background jobs will finish parameters onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writestringnonblocking "lorem ipsum dolor sit amet ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; /* calling flushnonblocking ensures that content will be written to file descriptor */ /* and can be read by any process */ filehandlewrite flushnonblocking function { console log "data has been flushed to system file buffer and now can be read" ; }, function error { console log error ; } ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; filehandleread readstringnonblocking function output { console log "file content " + output ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example number of bytes written 29 data has been flushed to system file buffer and now can be read file content lorem ipsum dolor sit amet file handle closed file handle closed sync synchronizes data to storage device void sync ; since 5 0 the sync function is intended to force a physical write of data from the buffer cache and to assure that after a system crash or other failure that all data up to the time of the sync call is recorded on the disk exceptions webapiexception with error type ioerror, if sync fails or any error related to file handle occurs code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedata datatowrite ; /* calling sync forces a physical write of data, so it is safe */ /* even after system crash or power shut down */ filehandlewrite sync ; console log "data has been synced" ; /* close method provides the same functionality as sync and ends access to file */ filehandlewrite close ; output example data has been synced **syncnonblocking ** synchronizes data to storage device void syncnonblocking optional successcallback? onsuccess, optional errorcallback? onerror ; since 5 0 the syncnonblocking function is intended to force a physical write of data from the buffer cache and to assure that after a system crash or other failure that all data up to the time of the syncnonblocking execution is recorded on the disk successful syncing invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if sync fails or any error related to file handle occurs this method is asynchronous its execution will occur in background and after all previously commissioned background jobs will finish parameters onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedatanonblocking datatowrite, function dataread { console log "write done" ; }, function error { console log error ; } ; /* calling syncnonblocking will force a physical write of data, so it will be safe */ /* even after system crash or power shut down */ filehandlewrite syncnonblocking function { console log "data has been synced" ; }, function error { console log error ; } ; /* close method provides the same functionality as sync and ends access to file */ filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example write done data has been synced file handle closed close closes file handle void close ; since 5 0 closes the given file stream closing file guarantees writing changes made to filehandle to the storage device further operations on this file handle are not allowed remark this method is synchronous if any asynchronous method was called before close, close will block further instructions until all background jobs finish execution note, that if file handle functions are put into any callbacks and this callback was not yet called, synchronous close will wait only for already ordered background jobs to finish, preventing successful execution of any further operations on closed file handle exceptions webapiexception with error type ioerror, if close fails or any error related to file handle occurs code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writestring "lorem ipsum dolor sit amet " ; filehandlewrite close ; console log "string has been written to the file" ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var positionoffileend = filehandleread seek 0, "end" ; console log "seek operation done position of file end " + positionoffileend ; filehandleread close ; console log "file is now closed" ; output example string has been written to the file seek operation done position of file end 29 file is now closed closenonblocking closes file handle void closenonblocking optional successcallback? onsuccess, optional errorcallback? onerror ; since 5 0 closes the given file stream closing file guarantees writing changes made to filehandle to the storage device further operations on this file handle are not allowed successful closing invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if close fails or any error related to file handle occurs this method is asynchronous its execution will occur in background and after all previously commissioned background jobs will finish parameters onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writestringnonblocking "lorem ipsum dolor sit amet ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var positionoffileend = filehandleread seeknonblocking 0, function new_position { console log "moved to position " + new_position ; }, function error { console log error ; }, "end" ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example number of bytes written 29 file handle closed moved to position 29 file handle closed 2 5 file the file interface represents the file abstraction in use deprecated since 5 0 [nointerfaceobject] interface file { readonly attribute file? parent; readonly attribute boolean readonly; readonly attribute boolean isfile; readonly attribute boolean isdirectory; readonly attribute date? created; readonly attribute date? modified; readonly attribute domstring path; readonly attribute domstring name; readonly attribute domstring fullpath; readonly attribute unsigned long long filesize; readonly attribute long length; domstring touri raises webapiexception ; void listfiles filearraysuccesscallback onsuccess, optional errorcallback? onerror, optional filefilter? filter raises webapiexception ; void openstream filemode mode, filestreamsuccesscallback onsuccess, optional errorcallback? onerror, optional domstring? encoding raises webapiexception ; void readastext filestringsuccesscallback onsuccess, optional errorcallback? onerror, optional domstring? encoding raises webapiexception ; void copyto domstring originfilepath, domstring destinationfilepath, boolean overwrite, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void moveto domstring originfilepath, domstring destinationfilepath, boolean overwrite, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; file createdirectory domstring dirpath raises webapiexception ; file createfile domstring relativefilepath raises webapiexception ; file resolve domstring filepath raises webapiexception ; void deletedirectory domstring directorypath, boolean recursive, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void deletefile domstring filepath, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; }; since 1 0 the file object permissions for the file object location and tree rooted at that location depend upon the mode defined in the resolve method when a file object creates a child file object, the new file object inherits its access rights from the parent object without any reference to the security framework, as noted in certain methods of file a file handle represents either a file or a directory for a file, the isfile attribute is set to true for a directory, the isdirectory attribute is set to true a file can be opened for both read and write operations, using a filestream handle a list of files and sub-directories can be obtained from a directory and a resolve method exists to resolve files or sub-directories more conveniently than processing directory listings a file handle representing a file can be opened for i/o operations, such as reading and writing a file handle representing a directory can be used for listing all files and directories rooted as the file handle location code example function onsuccess files { for var i = 0; i < files length; i++ { /* alerts each name of dir's content */ console log files[i] name ; } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } /* list directory content */ dir listfiles onsuccess, onerror ; attributes readonly file parent [nullable] the parent directory handle deprecated since 5 0 this attribute is set to null if there is no parent directory this also implies that this directory represents a root location since 1 0 code example /* list directory content */ dir listfiles onsuccess, onerror ; function onsuccess files { for var i = 0; i < files length; i++ { /* prints the file parent, must contain the */ /* same value for all the files in the loop */ console log "all the files should have the same parent " + files[i] parent ; } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } readonly boolean readonly the file/directory access state in the filesystem deprecated since 5 0 this attribute is set to true - if object has read-only access at its location false - if object has write access at its location this attribute represents the actual state of a file or directory in the filesystem its value is not affected by the mode used in filesystemmanager resolve that was used to create the file object from which this file object was obtained since 1 0 code example /* lists directory content */ dir listfiles onsuccess, onerror ; function onsuccess files { for var i = 0; i < files length; i++ { if files[i] readonly console log "cannot write to file " + files[i] name ; else console log "can write to file " + files[i] name ; } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } readonly boolean isfile the flag indicating whether it is a file deprecated since 5 0 this attribute can have the following values true if this handle is a file false if this handle is a directory since 1 0 readonly boolean isdirectory the flag indicating whether it is a directory deprecated since 5 0 this attribute can have the following values true if this handle is a directory false if this handle is a file since 1 0 readonly date created [nullable] the timestamp when a file is first created in the filesystem deprecated since 5 0 this timestamp is equivalent to the timestamp when a call to createfile succeeds if the platform does not support this attribute, it will be null it is unspecified and platform-dependent if the creation timestamp changes when a file is moved since 1 0 readonly date modified [nullable] the timestamp when the most recent modification is made to a file, usually when the last write operation succeeds deprecated since 5 0 opening a file for reading does not change the modification timestamp if the platform does not support this attribute, it will be null it is unspecified and platform-dependent if the modified timestamp changes when a file is moved since 1 0 code example console log file modified ; /* displays the modification timestamp */ readonly domstring path the path of a file after excluding its file name deprecated since 5 0 it begins with the name of the root containing the file, followed by the path, including the directory containing the file, but excluding the file name except in some special cases of the file representing the root itself, the last character is always "/" for example, if a file is located at music/ramones/volume1/rockawaybeach mp3, the path is music/ramones/volume1/ for example, if a directory is located at music/ramones/volume1, the path is music/ramones/ for the virtual roots, the path is same as the name of the virtual root for example, if the root is music, then the path is music if the root is documents, then the path is documents since 1 0 code example console log file path ; /* must be music/ if the file is music/foo mp3 */ readonly domstring name the file name after excluding the root name and any path components deprecated since 5 0 this is the name of this file, excluding the root name and any other path components for example, if a file is located at music/ramones/volume1/rockawaybeach mp3, the name is "rockawaybeach mp3" for example, if a directory is located at music/ramones/volume1, the name is be "volume1" for the special case of the root itself, the name is an empty string since 1 0 code example /* must be foo mp3 if the file path is music/foo mp3 */ console log file name ; readonly domstring fullpath the full path of a file deprecated since 5 0 it begins with the name of the root containing the file, and including the name of the file or directory itself for instance, if the rockawaybeach mp3 file is located at music/ramones/volume1/, then the fullpath is music/ramones/volume1/rockawaybeach mp3 for a directory, if the volume1 directory is located at music/ramones/, then the fullpath is music/ramones/volume1 for the special case of the root itself, if the root is music, then the fullpath is music the fullpath is always equal to path + name since 1 0 code example /* must be music/track1 mp3 if the file is music/track1 mp3 */ console log file fullpath ; readonly unsigned long long filesize the size of this file, in bytes deprecated since 5 0 if an attempt to read this attribute for a directory is made, undefined is returned to retrieve the number of files and directories contained in the directory, use the length attribute since 1 0 code example /* displays the file size */ console log file filesize ; readonly long length the number of files and directories contained in a file handle deprecated since 5 0 if an attempt to read this attribute for a file is made, undefined is returned to retrieve the size of a file, use the filesize attribute since 1 0 code example /* "3" if the directory contains two files and one sub-directory */ console log file length ; methods touri returns a uri for a file to identify an entry such as using it as the src attribute on an html img element the uri has no specific expiration, it should be valid at least as long as the file exists deprecated since 5 0 domstring touri ; since 1 0 if that uri corresponds to any of the public virtual roots that is images, videos, music, documents and downloads the uri must be globally unique and could be used by any widget if that uri corresponds to a file located in any a widget's private areas such as wgt-package, wgt-private, wgt-private-tmp , the generated uri must be unique for that file and for the widget making the request such as including some derived from the widget id in the uri these uris must not be accessible to other widgets, apart from the one invoking this method privilege level public privilege http //tizen org/privilege/filesystem read return value domstring uri that identifies the file or null if an error occurs exceptions webapiexception with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges with error type unknownerror, if any other error occurred code example tizen filesystem resolve "music/ramones/rockawaybeach mp3", function file { var audio = new audio file touri ; audio play ; console log file touri ; } ; listfiles lists all files in a directory deprecated since 5 0 void listfiles filearraysuccesscallback onsuccess, optional errorcallback? onerror, optional filefilter? filter ; since 1 0 the list of files is passed as a file[] in onsuccess and contains directories and files however, the directories " " and " " must not be returned each file object that is part of the array must inherit all the access rights that is, one of the values in filemode from the file object in which this method is invoked if the filter is passed and contains valid values, only those directories and files in the directory that match the filter criteria specified in the filefilter interface must be returned in the onsuccess method if no filter is passed, the filter is null or undefined, or the filter contains invalid values, the implementation must return the full list of files in the directory if the directory does not contain any files or directories, or the filter criteria do not match any files or directories, the onsuccess is invoked with an empty array the errorcallback is launched with these error types ioerror - if the operation is launched on a file not a directory invalidvalueserror - if any of the input parameters contain an invalid value unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read parameters onsuccess callback method to be invoked when the list operation has been successfully completed onerror [optional] [nullable] callback method to be invoked when an error has occurred filter [optional] [nullable] criteria to restrict the listed files exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example function onsuccess files { console log "there are " + files length + " in the selected folder" ; } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "r" ; openstream opens the file in the given mode supporting a specified encoding deprecated since 5 0 void openstream filemode mode, filestreamsuccesscallback onsuccess, optional errorcallback? onerror, optional domstring? encoding ; since 1 0 this operation is performed asynchronously if the file is opened successfully, the onsuccess method is invoked with a filestream that can be used for reading and writing the file, depending on the mode the returned filestream instance includes a file pointer, which represents the current position in the file the file pointer, by default, is at the start of the file, except in the case of opening a file in append "a" mode, in which case the file pointer points to the end of the file the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value ioerror - the operation is launched on a directory not a file , the file is not valid or it does not exist unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read parameters mode mode in which the file is opened "r" for reading "a" for appending "w" for [over]writing "rw" for reading and writing onsuccess callback method to be invoked when a file has been opened onerror [optional] [nullable] callback method to be invoked when an error has occurred encoding [optional] [nullable] encoding to use for read/write operations on the file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin1 encoding if no encoding is passed by the developer, then the default platform encoding must be used exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { console log "file name is " + files[i] name ; /* displays file name */ } var testfile = documentsdir createfile "test txt" ; if testfile != null { testfile openstream "w", function fs { fs write "helloworld" ; fs close ; }, function e { console log "error " + e message ; }, "utf-8" ; } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; readastext reads the content of a file as a domstring deprecated since 5 0 void readastext filestringsuccesscallback onsuccess, optional errorcallback? onerror, optional domstring? encoding ; since 1 0 if the operation is successfully executed, the onsuccess method is invoked and a domstring is passed as input parameter that represents the file content in the format determined by the encoding parameter the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value ioerror - if the operation is launched on a directory not a file , the file is not valid, or the file does not exist unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read parameters onsuccess callback method to be invoked when a file has been successfully read onerror [optional] [nullable] callback method to be invoked when an error occurs while reading a file encoding [optional] [nullable] encoding for read/write operations on a file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin1 encoding if no encoding is passed by the developer, then the default platform encoding must be used exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { console log "file name is " + files[i] name ; /* displays file name */ if files[i] isdirectory == false { files[i] readastext function str { console log "the file content " + str ; }, function e { console log "error " + e message ; }, "utf-8" ; } } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; copyto copies and overwrites if possible and specified a file or a directory from a specified location to another specified location deprecated since 5 0 void copyto domstring originfilepath, domstring destinationfilepath, boolean overwrite, optional successcallback? onsuccess, optional errorcallback? onerror ; since 1 0 the copy of the file or directory identified by the originfilepath parameter must be created in the path passed in the destinationfilepath parameter the file or directory to copy must be under the directory from which the method is invoked, otherwise the operation must not be performed if the copy is performed successfully, the onsuccess method is invoked the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value notfounderror - if the originfilepath does not correspond to a valid file or destinationpath is not a valid path ioerror - if the file in which the copyto method is invoked is a file and not a directory , originfilepath corresponds to a file or directory in use by another process, overwrite parameter is false and destinationfilepath corresponds to an existing file or directory unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem write parameters originfilepath origin full virtual file or directory path and it must be under the current directory destinationfilepath new full virtual file path or directory path overwrite attribute to determine whether overwriting is allowed or not if set to true, it enforces overwriting an existing file onsuccess [optional] [nullable] callback method to be invoked when the file has been copied onerror [optional] [nullable] callback method to be invoked when an error has occurred exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { if files[i] isdirectory == false { documentsdir copyto files[i] fullpath, "images/backup/" + files[i] name, false, function { console log "file copied" ; } ; } } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; moveto moves and overwrites if possible and specified a file or a directory from a specified location to another this operation is different from instantiating copyto and then deleting the original file, as on certain platforms, this operation does not require extra disk space deprecated since 5 0 void moveto domstring originfilepath, domstring destinationfilepath, boolean overwrite, optional successcallback? onsuccess, optional errorcallback? onerror ; since 1 0 the file or directory identified by the originfilepath parameter is moved to the path passed in the destinationfilepath parameter the file to move must be under the directory from which the method is invoked, else the operation can not be performed if the file or directory is moved successfully, the onsuccess method is invoked the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value notfounderror - if originfilepath does not correspond to a valid file or destinationpath is not a valid path ioerror - if the file in which the moveto method is invoked is a file not a directory , originfilepath corresponds to a file or directory in use by another process, overwrite parameter is false and destinationfilepath corresponds to an existing file or directory unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem write parameters originfilepath origin full virtual file or directory path and it must be under the current directory destinationfilepath new full virtual file path or directory path overwrite flag indicating whether to overwrite an existing file when set to true, the files can be overwritten onsuccess [optional] [nullable] callback method to be invoked when the file has been moved onerror [optional] [nullable] callback method to be invoked when an error has occurred exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { if files[i] isdirectory == false { documentsdir moveto files[i] fullpath, "images/newfolder/" + files[i] name, false, function { console log "file moved" ; } ; } } } function onerror error { console log "the error " + error message + " occurred during listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; createdirectory creates a new directory deprecated since 5 0 file createdirectory domstring dirpath ; since 1 0 a new directory will be created relative to the current directory that this operation is performed on the implementation will attempt to create all necessary sub-directories specified in the dirpath, as well the use of " " or " " in path components is not supported this operation can only be performed on file handles that represent directories that is, isdirectory == true if the directory is successfully created, it will be returned in case the directory cannot be created, an error must be thrown with the appropriate error type privilege level public privilege http //tizen org/privilege/filesystem write parameters dirpath relative directory path and it only contains characters supported by the underlying filesystem return value file file handle of the new directory the new file object has "rw" access rights, as it inherits this from the file object on which the createdirectory method is called exceptions webapiexception with error type ioerror, if the dirpath already exists, if the file in which the createdirectory method is invoked is a file and not a directory with error type invalidvalueserror, if the dirpath does not contain a valid path with error type typemismatcherror, if the input parameter is not compatible with the expected type with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type unknownerror, if any other error occurs code example var dir; /* directory object obtained from filesystem api */ var newdir = dir createdirectory "newdir" ; var anothernewdir = dir createdirectory "newdir1/subnewdir1" ; createfile creates a empty new file in a specified location that is relative to the directory indicated by current file object's path attribute deprecated since 5 0 file createfile domstring relativefilepath ; since 1 0 the use of " " or " " in path components is not supported this operation can only be performed on file handlers that represent a directory that is, isdirectory == true if the file is successfully created, a file handle must be returned by this method in case the file cannot be created, an error must be thrown with the appropriate error type privilege level public privilege http //tizen org/privilege/filesystem write parameters relativefilepath new file path and it should only contain characters supported by the underlying filesystem return value file file handle for the new empty file the new file object has "rw" access rights, as it inherits this from the file object on which the createfile method is called exceptions webapiexception with error type ioerror, if relativefilepath already exists, if the file in which the createfile method is invoked is a file not a directory with error type invalidvalueserror, if relativefilepath contains an invalid value with error type typemismatcherror, if the input parameter is not compatible with the expected type with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type unknownerror, if any other error occurs code example var newfile = dir createfile "newfilepath" ; resolve resolves an existing file or directory relative to the current directory this operation is performed on and returns a file handle for it deprecated since 5 0 file resolve domstring filepath ; since 1 0 the filepath is not allowed to contain the " " or " " directory entries inside its value the encoding of file paths is utf-8 privilege level public privilege http //tizen org/privilege/filesystem read parameters filepath relative file path or file uri to resolve return value file file handle of the file the new file object inherits its access rights from the file object on which this resolve method is called exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type invalidvalueserror, if the file path contains an invalid value with error type ioerror, if the method is executed in a file object that does not represent a directory that is, isdirectory attribute is false with error type notfounderror, if a file does not exist for the passed file path with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges with error type unknownerror, if any other error occurs code example var file; /* resolves helloworld doc file that is located in the */ /* documents root location */ tizen filesystem resolve "documents", function dir { file = dir resolve "helloworld doc" ; }, function e { console log "error " + e message ; }, "rw" ; deletedirectory deletes a specified directory and directory tree if specified deprecated since 5 0 void deletedirectory domstring directorypath, boolean recursive, optional successcallback? onsuccess, optional errorcallback? onerror ; since 1 0 this method attempts to asynchronously delete a directory or directory tree under the current directory if the recursive parameter is set to true, all the directories and files under the specified directory must be deleted if the recursive parameter is set to false, the directory is only deleted if it is empty, otherwise an ioerror error type will be passed in onerror if the deletion is performed successfully, the onsuccess is invoked the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value notfounderror -if the passed directory does not correspond to a valid directory ioerror - if the file in which the delete method is invoked is a file and not a directory , the directory is in use by another process or the directory is not empty and recursive argument is false this code is also used if a recursive deletion partially fails and any data deleted so far cannot be recovered this may occur due to the lack of filesystem permissions or if any directories or files are already opened by other processes unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem write parameters directorypath full virtual path to the directory to delete must be under the current one recursive flag indicating whether the deletion is recursive or not when set to true recursive deletion is allowed also, this function deletes all data in all subdirectories and so needs to be used with caution onsuccess [optional] [nullable] callback method to be invoked when a directory is successfully deleted onerror [optional] [nullable] callback method to be invoked when an error has occurred exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { if files[i] isdirectory { documentsdir deletedirectory files[i] fullpath, false, function { console log "directory deleted" ; }, function e { console log "error " + e message ; } ; } } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; deletefile deletes a specified file this function attempts to asynchronously delete a file under the current directory deprecated since 5 0 void deletefile domstring filepath, optional successcallback? onsuccess, optional errorcallback? onerror ; since 1 0 if the deletion is performed successfully, the onsuccess is invoked the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value notfounderror - if the file does not correspond to a valid file ioerror - if the file in which the delete method is invoked is a file not a directory , the file is in use by another process, or there is no permission in the file system unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem write parameters filepath full virtual path to the file to delete must be under the current directory onsuccess [optional] [nullable] callback method to be invoked when the file is successfully deleted onerror [optional] [nullable] callback method to be invoked when an error has occurred exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { if !files[i] isdirectory { documentsdir deletefile files[i] fullpath, function { console log "file deleted" ; }, function e { console log "error " + e message ; } ; } } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; 2 6 filefilter the dictionary that defines attributes to filter the items returned by the listdirectory method or deprecated listfiles dictionary filefilter { domstring name; boolean isfile; boolean isdirectory; date startmodified; date endmodified; date startcreated; date endcreated; }; since 1 0 when this dictionary is passed to a method, the result-set of the method will only contain file item entries that match the attribute values of the filter a file item only matches the filefilter object if all of the defined filter's attribute values match all of the file item's attributes only matching values other than undefined or null this is similar to a sql's "and" operation an attribute of the file entry matches the filefilter attribute value in accordance with the following rules for filefilter attributes of type domstring, an entry matches this value only if its corresponding attribute is an exact match if the filter contains u+0025 "percent sign" it is interpreted as a wildcard character and "%" matches any string of any length, including no length if wildcards are used, the behavior is similar to the like condition in sql to specify that a "percent sign" character is to be considered literally instead of interpreting it as a wildcard, developers can escape it with the backslash character please, remember that the backslash character has to be escaped itself, to not to be removed from the string - proper escaping of the "percent sign" in javascript string requires preceding it with double backslash "%" the matching is not case sensitive, such as "foo" matches a "foo" or an "f%" filter for file entry attributes of type date, attributes start and end are included to allow filtering of file entries between two supplied dates if either or both of these attributes are specified, the following rules apply a if both start and end dates are specified that is, other than null , a file entry matches the filter if its corresponding attribute is the same as either start or end or between the two supplied dates that is, after start and before end b if only the start attribute contains a value other than null , a file entry matches the filter if its corresponding attribute is later than or equal to the start one c if only the end date contains a value other than null , a file matches the filter if its corresponding attribute is earlier than or equal to the end date dictionary members domstring name the file name attribute filter files that have a name that corresponds with this attribute either exactly or with the specified wildcards match this filtering criteria since 1 0 boolean isfile if true match only files if false do not match files may be undefined since 5 0 boolean isdirectory if true match only directories, if false do not match directories may be undefined since 5 0 date startmodified the file modified attribute filter files with modified date later than this attribute or equal to it match the filtering criteria since 1 0 date endmodified the file modified attribute filter files with modified date earlier than this attribute or equal to it match the filtering criteria since 1 0 date startcreated the file created attribute filter files with created date later than this attribute or equal to it match the filtering criteria since 1 0 date endcreated the file created attribute filter files with created date earlier than this attribute or equal to it match the filtering criteria since 1 0 2 7 filestream the filestream interface represents a handle to a file opened for read and/or write operations read and write operations are performed relative to a position attribute, which is a pointer that represents the current position in the file deprecated since 5 0 [nointerfaceobject] interface filestream { readonly attribute boolean eof; attribute long position; readonly attribute long bytesavailable; void close ; domstring read long charcount raises webapiexception ; octet[] readbytes long bytecount raises webapiexception ; domstring readbase64 long bytecount raises webapiexception ; void write domstring stringdata raises webapiexception ; void writebytes octet[] bytedata raises webapiexception ; void writebase64 domstring base64data raises webapiexception ; }; since 1 0 a series of read/write methods are available that permit both binary and text to be processed once a file stream is closed, any operation attempt made on this stream results in a standard javascript error the read/write operations in this interface do not throw any security exceptions as the access rights are expected to be granted through the initial resolve method or through the openstream method of the file interface therefore, all actions performed on a successfully resolved file and filestream are expected to succeed this avoids successive asynchronous calls and may potentially increase application for a user attributes readonly boolean eof the flag indicating whether the current file pointer is at the end of the file deprecated since 5 0 if set to true, this attribute indicates that the file pointer is at the end of the file if set to false, this attribute indicates that the file pointer is not at the end of the file and so it is anywhere within the file since 1 0 code example if stream eof { /* file has been read completely */ } long position the flag indicating the stream position for reads/writes deprecated since 5 0 the stream position is an offset of bytes from the start of the file stream when invoking an operation that reads or writes from the stream, the operation will take place from the byte defined by this position attribute if the read or write operation is successful, the position of the stream is advanced by the number of bytes read or written if the read/write operation is not successful, the position of the stream is unchanged since 1 0 code example console log stream position ; /* displays current stream position */ /* alters current stream position to the begin of the file, */ /* like seek in c */ stream position = 0; readonly long bytesavailable the number of bytes that are available for reading from the stream deprecated since 5 0 the number of bytes available for reading is the maximum amount of bytes that can be read in the next read operation it corresponds to the number of bytes available after the file pointer denoted by the position attribute -1 if eof is true since 1 0 code example console log stream bytesavailable ; /* displays the available bytes to be read */ methods close closes this filestream deprecated since 5 0 void close ; since 1 0 flushes any pending buffered writes and closes the file always succeeds note that pending writes might not succeed privilege level public privilege http //tizen org/privilege/filesystem read code example stream close ; /* closes this stream, no subsequent access to stream allowed */ read reads the specified number of characters from the position of the file pointer in a filestream and returns the characters as a string the resulting string length might be shorter than charcount if eof is true deprecated since 5 0 domstring read long charcount ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters charcount number of characters being read return value domstring array of read characters as a string exceptions webapiexception with error type ioerror, if a read error occurs, such as the bytes in the stream cannot be decoded with the encoding in use with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type invalidvalueserror, if any of the input parameters contains an invalid value with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example var text = stream read file filesize ; stream close ; readbytes reads the specified number of bytes from a filestream deprecated since 5 0 octet[] readbytes long bytecount ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters bytecount number of bytes to read return value octet[] result of read bytes as a byte or number array exceptions webapiexception with error type ioerror, if a read error occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type invalidvalueserror, if any of the input parameters contains an invalid value with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example /* reads up to 256 bytes from the stream */ var raw = stream readbytes 256 ; for var i = 0; i < raw length; i++ { /* raw[i] contains the i-th byte of the current data chunk */ } readbase64 reads the specified number of bytes from this filestream, encoding the result in base64 deprecated since 5 0 domstring readbase64 long bytecount ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters bytecount number of bytes to read return value domstring array of read characters as base64 encoding string exceptions webapiexception with error type ioerror, if a read error occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type invalidvalueserror, if any of the input parameters contains an invalid value with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example /* reads up to 256 bytes from the stream */ var base64 = stream readbase64 256 ; write writes the specified domstring to a filestream deprecated since 5 0 void write domstring stringdata ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem write parameters stringdata actual string to write exceptions webapiexception with error type ioerror, if a write error occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example var text = "hello world"; stream write text ; writebytes writes the specified bytes to this filestream deprecated since 5 0 void writebytes octet[] bytedata ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem write parameters bytedata byte data array being written exceptions webapiexception with error type ioerror, if a write error occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example var bytes = input readbytes 256 ; /* writes the bytes read from input to output */ output writebytes bytes ; writebase64 writes the result to this filestream after converting the specified base64 domstring to bytes deprecated since 5 0 void writebase64 domstring base64data ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem write parameters base64data the base64 data to written exceptions webapiexception with error type ioerror, if an error occurs during writebase64 with error type invalidvalueserror, if the input parameter contains an invalid value e g the base64data input parameter is not a valid base64 sequence with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example var base64 = input readbase64 256 ; /* writes the base64 data read from input to output */ output writebase64 base64 ; 2 8 filesuccesscallback the filesuccesscallback interface defines file system success callback with a file object as input argument deprecated since 5 0 [callback=functiononly, nointerfaceobject] interface filesuccesscallback { void onsuccess file file ; }; since 1 0 it is used in asynchronous operations, such as filesystemmanager resolve , copying, moving and deleting files methods onsuccess called when the asynchronous call completes successfully deprecated since 5 0 void onsuccess file file ; since 1 0 parameters file file resulting from the asynchronous call 2 9 filesystemstoragearraysuccesscallback the filesystemstoragearraysuccesscallback callback interface specifies a success callback with an array of filesystemstorage objects as input argument [callback=functiononly, nointerfaceobject] interface filesystemstoragearraysuccesscallback { void onsuccess filesystemstorage[] storages ; }; since 1 0 it is used in asynchronous operations, such as filesystemmanager liststorages methods onsuccess called when the asynchronous call completes successfully void onsuccess filesystemstorage[] storages ; since 1 0 parameters storages list of available storage devices 2 10 filesystemstoragesuccesscallback the filesystemstoragesuccesscallback callback interface specifies a success callback with a filesystemstorage object as input argument [callback=functiononly, nointerfaceobject] interface filesystemstoragesuccesscallback { void onsuccess filesystemstorage storage ; }; since 1 0 it is used in asynchronous operations, such as filesystemmanager getstorage and filesystemmanager addstoragestatechangelistener methods onsuccess called when the asynchronous call completes successfully void onsuccess filesystemstorage storage ; since 1 0 parameters storage storage device structure 2 11 pathsuccesscallback the pathsuccesscallback callback interface specifies a success callback with a path value as input argument [callback=functiononly, nointerfaceobject] interface pathsuccesscallback { void onsuccess path path ; }; since 5 0 it is used in asynchronous operations of the filesystemmanager interface methods onsuccess called when the asynchronous call completes successfully void onsuccess path path ; since 5 0 parameters path path to created or changed resource on the filesystem in case of deletion, path to parent of the deleted resource is given 2 12 seeksuccesscallback the seeksuccesscallback callback interface specifies a success callback with a long long value as input argument [callback=functiononly, nointerfaceobject] interface seeksuccesscallback { void onsuccess long long position ; }; since 5 0 it is used in asynchronous operation filehandle seeknonblocking methods onsuccess called when the asynchronous call completes successfully void onsuccess long long position ; since 5 0 parameters position file position indicator 2 13 readstringsuccesscallback the readstringsuccesscallback callback interface specifies a success callback with a domstring value as input argument [callback=functiononly, nointerfaceobject] interface readstringsuccesscallback { void onsuccess domstring string ; }; since 5 0 it is used in asynchronous operation filehandle readstringnonblocking methods onsuccess called when the asynchronous call completes successfully void onsuccess domstring string ; since 5 0 parameters string string with data read from file 2 14 writestringsuccesscallback the writestringsuccesscallback callback interface specifies a success callback with a long long value as input argument [callback=functiononly, nointerfaceobject] interface writestringsuccesscallback { void onsuccess long long bytescount ; }; since 5 0 it is used in asynchronous operation filehandle writestringnonblocking methods onsuccess called when the asynchronous call completes successfully void onsuccess long long bytescount ; since 5 0 parameters bytescount number of bytes written can be more than inputstring length for multibyte encodings and will never be less 2 15 readblobsuccesscallback the readblobsuccesscallback callback interface specifies a success callback with a blob object as input argument [callback=functiononly, nointerfaceobject] interface readblobsuccesscallback { void onsuccess blob blob ; }; since 5 0 it is used in asynchronous operation filehandle readblobnonblocking methods onsuccess called when the asynchronous call completes successfully void onsuccess blob blob ; since 5 0 parameters blob blob object with file content 2 16 readdatasuccesscallback the readdatasuccesscallback callback interface specifies a success callback with a uint8array value as input argument [callback=functiononly, nointerfaceobject] interface readdatasuccesscallback { void onsuccess uint8array data ; }; since 5 0 it is used in asynchronous operation filehandle readdatanonblocking methods onsuccess called when the asynchronous call completes successfully void onsuccess uint8array data ; since 5 0 parameters data a typedarray with file content 2 17 filestringsuccesscallback the filestringsuccesscallback callback interface specifies a success callback with a domstring object as input argument deprecated since 5 0 [callback=functiononly, nointerfaceobject] interface filestringsuccesscallback { void onsuccess domstring filestr ; }; since 1 0 it is used in asynchronous operation file readastext methods onsuccess called when the asynchronous call completes successfully deprecated since 5 0 void onsuccess domstring filestr ; since 1 0 parameters filestr file represented as a domstring resulting from the asynchronous call 2 18 filestreamsuccesscallback the filestreamsuccesscallback interface specifies a success callback with a filestream object as input argument deprecated since 5 0 [callback=functiononly, nointerfaceobject] interface filestreamsuccesscallback { void onsuccess filestream filestream ; }; since 1 0 it is used in asynchronous operation file openstream methods onsuccess called when the file openstream asynchronous call completes successfully deprecated since 5 0 void onsuccess filestream filestream ; since 1 0 parameters filestream filestream to access file content 2 19 listdirectorysuccesscallback the listdirectorysuccesscallback interface defines success callback for listing methods [callback=functiononly, nointerfaceobject] interface listdirectorysuccesscallback { void onsuccess domstring[] names, path path ; }; since 5 0 this callback interface specifies a success callback with a function taking an array of strings as input argument it is used in asynchronous operation filesystemmanager listdirectory methods onsuccess called when the asynchronous call completes successfully void onsuccess domstring[] names, path path ; since 5 0 parameters names file or directory names resulting from the asynchronous call path path to listed directory 2 20 filearraysuccesscallback the filearraysuccesscallback interface defines file system specific success callback for listing methods deprecated since 5 0 [callback=functiononly, nointerfaceobject] interface filearraysuccesscallback { void onsuccess file[] files ; }; since 1 0 this callback interface specifies a success callback with a function taking an array of file objects as input argument it is used in asynchronous methods, such as file listfiles methods onsuccess called when the asynchronous call completes successfully deprecated since 5 0 void onsuccess file[] files ; since 1 0 parameters files files resulting from the asynchronous call 3 full webidl module filesystem { typedef domstring path; typedef blob blob; enum filemode { "a", "r", "rw", "rwo", "w" }; enum filesystemstoragetype { "internal", "external" }; enum filesystemstoragestate { "mounted", "removed", "unmountable" }; enum baseseekposition { "begin", "current", "end" }; dictionary filefilter { domstring name; boolean isfile; boolean isdirectory; date startmodified; date endmodified; date startcreated; date endcreated; }; tizen implements filesystemmanagerobject; [nointerfaceobject] interface filesystemmanagerobject { readonly attribute filesystemmanager filesystem; }; [nointerfaceobject] interface filesystemmanager { readonly attribute long maxnamelength; readonly attribute long maxpathlength; filehandle openfile path path, filemode openmode, optional boolean makeparents raises webapiexception ; void createdirectory path path, optional boolean makeparents, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void deletefile path path, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void deletedirectory path path, optional boolean recursive, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void copyfile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void copydirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void movefile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void movedirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void rename path path, domstring newname, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void listdirectory path path, listdirectorysuccesscallback successcallback, optional errorcallback? errorcallback, optional filefilter? filter raises webapiexception ; domstring touri path path raises webapiexception ; boolean isfile path path raises webapiexception ; boolean isdirectory path path raises webapiexception ; boolean pathexists path path raises webapiexception ; domstring getdirname domstring path ; void getstorage domstring label, filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; void liststorages filesystemstoragearraysuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; long addstoragestatechangelistener filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; void removestoragestatechangelistener long watchid raises webapiexception ; }; [nointerfaceobject] interface filesystemstorage { readonly attribute domstring label; readonly attribute filesystemstoragetype type; readonly attribute filesystemstoragestate state; }; [nointerfaceobject] interface filehandle { readonly attribute path path; long long seek long long offset, optional baseseekposition whence raises webapiexception ; void seeknonblocking long long offset, optional seeksuccesscallback? onsuccess, optional errorcallback? onerror, optional baseseekposition whence raises webapiexception ; domstring readstring optional long long? count, optional domstring inputencoding raises webapiexception ; void readstringnonblocking optional readstringsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long count, optional domstring inputencoding raises webapiexception ; long long writestring domstring inputstring, optional domstring outputencoding raises webapiexception ; void writestringnonblocking domstring inputstring, optional writestringsuccesscallback? onsuccess, optional errorcallback? onerror, optional domstring outputencoding raises webapiexception ; blob readblob optional long long size raises webapiexception ; void readblobnonblocking optional readblobsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size raises webapiexception ; void writeblob blob blob raises webapiexception ; void writeblobnonblocking blob blob, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; uint8array readdata optional long long size raises webapiexception ; void readdatanonblocking optional readdatasuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size raises webapiexception ; void writedata uint8array data raises webapiexception ; void writedatanonblocking uint8array data, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void flush raises webapiexception ; void flushnonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void sync raises webapiexception ; void syncnonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void close raises webapiexception ; void closenonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; }; [callback=functiononly, nointerfaceobject] interface filesystemstoragearraysuccesscallback { void onsuccess filesystemstorage[] storages ; }; [callback=functiononly, nointerfaceobject] interface filesystemstoragesuccesscallback { void onsuccess filesystemstorage storage ; }; [callback=functiononly, nointerfaceobject] interface pathsuccesscallback { void onsuccess path path ; }; [callback=functiononly, nointerfaceobject] interface seeksuccesscallback { void onsuccess long long position ; }; [callback=functiononly, nointerfaceobject] interface readstringsuccesscallback { void onsuccess domstring string ; }; [callback=functiononly, nointerfaceobject] interface writestringsuccesscallback { void onsuccess long long bytescount ; }; [callback=functiononly, nointerfaceobject] interface readblobsuccesscallback { void onsuccess blob blob ; }; [callback=functiononly, nointerfaceobject] interface readdatasuccesscallback { void onsuccess uint8array data ; }; [callback=functiononly, nointerfaceobject] interface listdirectorysuccesscallback { void onsuccess domstring[] names, path path ; }; };

filesystem api the filesystem api provides access to a device's filesystem the filesystem is represented as an abstract collection of disjointed filesystem virtual root locations, each corresponding to a specific location in the device filesystem the filesystem api exposes the hierarchies below these root locations as autonomous virtual filesystems each virtual root has a string name each file or directory within the virtual filesystem is addressed using a fully-qualified path of the form <root name>/<path> where <rootname> is the name of the virtual root and <path> is the path to the file or directory relative to that root the following virtual roots must be supported images - the location for images videos - the location for videos music - the location for sounds documents - the location for documents downloads - the location for downloaded items camera - the location for the pictures and videos taken by a device supported since tizen 2 3 wgt-package - the location for widget package which is read-only wgt-private - the location for a widget's private storage wgt-private-tmp - the location for a widget's private volatile storage removable_ - the location for external storages the " " suffix is a unique identifier of an external storage to obtain list of available external storages use liststorages the file uri path is also supported to access paths out of virtual root, for example "file ///tmp" can be used as location parameter the implementation must support the use of the following characters in file names letters a-z, a-z digits 0-9 blank space underscore "_" hyphen "-" period " " the implementation may support additional characters in file names, depending on platform support the implementation may forbid the use of additional characters in file names, depending on the platform the use of the path component separator "/" and null character "x00" should not be allowed in file names some other file name and path characteristics are platform-dependent, for example, maximum path length, file name length, case sensitivity, additional character support, etc therefore, it is recommended to avoid any dependency on aspects that cannot be supported across multiple platforms the encoding used for the file path should be utf-16 default for ecmascript string remark in order to access files, a proper privilege has to be defined additionally for accessing only internal storage using this api, a privilege http //tizen org/privilege/mediastorage must be provided, for accessing only external storage using this api, a privilege http //tizen org/privilege/externalstorage must be provided, for accessing internal and external storage using this api, privileges http //tizen org/privilege/mediastorage and http //tizen org/privilege/externalstorage must be provided remark methods, which names end with nonblocking are asynchronous and are executed in background in the order in which they were called corresponding methods without nonblocking at the end are synchronous and will block further instructions execution, until they are finished for more information on the filesystem features, see file system guide since 1 0 summary of interfaces and methods interface method filesystemmanagerobject filesystemmanager filehandle openfile path path, filemode openmode, optional boolean makeparents void createdirectory path path, optional boolean makeparents, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void deletefile path path, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void deletedirectory path path, optional boolean recursive, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void copyfile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void copydirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void movefile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void movedirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void rename path path, domstring newname, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void listdirectory path path, listdirectorysuccesscallback successcallback, optional errorcallback? errorcallback, optional filefilter? filter domstring touri path path boolean isfile path path boolean isdirectory path path boolean pathexists path path domstring getdirname domstring path void getstorage domstring label, filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror void liststorages filesystemstoragearraysuccesscallback onsuccess, optional errorcallback? onerror long addstoragestatechangelistener filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror void removestoragestatechangelistener long watchid filesystemstorage filehandle long long seek long long offset, optional baseseekposition whence void seeknonblocking long long offset, optional seeksuccesscallback? onsuccess, optional errorcallback? onerror, optional baseseekposition whence domstring readstring optional long long? count, optional domstring inputencoding void readstringnonblocking optional readstringsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long count, optional domstring inputencoding long long writestring domstring inputstring, optional domstring outputencoding void writestringnonblocking domstring inputstring, optional writestringsuccesscallback? onsuccess, optional errorcallback? onerror, optional domstring outputencoding blob readblob optional long long size void readblobnonblocking optional readblobsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size void writeblob blob blob void writeblobnonblocking blob blob, optional successcallback? onsuccess, optional errorcallback? onerror uint8array readdata optional long long size void readdatanonblocking optional readdatasuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size void writedata uint8array data void writedatanonblocking uint8array data, optional successcallback? onsuccess, optional errorcallback? onerror void flush void flushnonblocking optional successcallback? onsuccess, optional errorcallback? onerror void sync void syncnonblocking optional successcallback? onsuccess, optional errorcallback? onerror void close void closenonblocking optional successcallback? onsuccess, optional errorcallback? onerror filefilter filesystemstoragearraysuccesscallback void onsuccess filesystemstorage[] storages filesystemstoragesuccesscallback void onsuccess filesystemstorage storage pathsuccesscallback void onsuccess path path seeksuccesscallback void onsuccess long long position readstringsuccesscallback void onsuccess domstring string writestringsuccesscallback void onsuccess long long bytescount readblobsuccesscallback void onsuccess blob blob readdatasuccesscallback void onsuccess uint8array data listdirectorysuccesscallback void onsuccess domstring[] names, path path 1 type definitions 1 1 path string, which points to file or directory typedef domstring path; since 5 0 in methods available since tizen 5 0, checking or accessing files or directories may be granted only through a valid path paths may contain one of the supported virtual roots the valid path pattern is explained on the top of the page 1 2 filemode specifies the file mode when it is opened enum filemode { "a", "r", "rw", "rwo", "w" }; since 1 0 the file modes defined by this enumerator are a - append access r - read-only access rw - read and write access rwo - read and write access original file content are deleted w - write access remark rwo mode is supported since tizen 5 0 it will not be recognized by deprecated functions 1 3 filesystemstoragetype specifies the type of storage enum filesystemstoragetype { "internal", "external" }; since 1 0 internal - internal storage is a storage that cannot be removed, such as a flash memory external - external storage is removable storage, such as a usb drive or a memory card 1 4 filesystemstoragestate specifies the state of the storage enum filesystemstoragestate { "mounted", "removed", "unmountable" }; since 1 0 mounted - the device is mounted and can be browsed removed - the device has been removed this states applies only to external drives unmountable - the device cannot be mounted due to an error 1 5 blob this is a blob object defined in w3c file api see the blob interface typedef blob blob; since 5 0 1 6 baseseekposition specifies starting point for seek operation enum baseseekposition { "begin", "current", "end" }; since 5 0 begin - beginning of the file current - current position of file indicator end - end of the file 2 interfaces 2 1 filesystemmanagerobject the filesystemmanagerobject interface defines what is instantiated by the tizen object [nointerfaceobject] interface filesystemmanagerobject { readonly attribute filesystemmanager filesystem; }; tizen implements filesystemmanagerobject; since 1 0 there is a tizen filesystem object that allows accessing the functionality of the filesystem api attributes readonly filesystemmanager filesystem object representing a filesystem since 1 0 2 2 filesystemmanager the filesystemmanager interface provides access to the filesystem api [nointerfaceobject] interface filesystemmanager { readonly attribute long maxnamelength; readonly attribute long maxpathlength; filehandle openfile path path, filemode openmode, optional boolean makeparents raises webapiexception ; void createdirectory path path, optional boolean makeparents, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void deletefile path path, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void deletedirectory path path, optional boolean recursive, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void copyfile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void copydirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void movefile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void movedirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void rename path path, domstring newname, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void listdirectory path path, listdirectorysuccesscallback successcallback, optional errorcallback? errorcallback, optional filefilter? filter raises webapiexception ; domstring touri path path raises webapiexception ; boolean isfile path path raises webapiexception ; boolean isdirectory path path raises webapiexception ; boolean pathexists path path raises webapiexception ; domstring getdirname domstring path ; void resolve domstring location, filesuccesscallback onsuccess, optional errorcallback? onerror, optional filemode? mode raises webapiexception ; void getstorage domstring label, filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; void liststorages filesystemstoragearraysuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; long addstoragestatechangelistener filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; void removestoragestatechangelistener long watchid raises webapiexception ; }; since 1 0 this manager interface exposes the filesystem base api and provides functionalities, such as determining root and default locations, resolving a given location into a file handle and registering filesystem listeners for filesystem events attributes readonly long maxnamelength the maximum file or directory name length for the current platform since 5 0 code example console log "the maximum name length is " + tizen filesystem maxnamelength ; output example the maximum name length is 255 readonly long maxpathlength the maximum path length limit for the current platform since 1 0 code example console log "the maximum path length is " + tizen filesystem maxpathlength ; output example the maximum path length is 4096 methods openfile opens a file or creates a file pointed by path filehandle openfile path path, filemode openmode, optional boolean makeparents ; since 5 0 if the operation succeeds, a file handle to the newly created or opened file is returned, otherwise an exception is thrown following file open modes are supported a - append mode file position indicator is always set to the first position after the last character of the file and cannot be modified with seek operations write operations always append content to the end of the file original file content are not modified read operations cannot be performed if the file does not exist, it is created r - read mode file position indicator is initially set to the beginning of the file and may be changed with seek operations write operations cannot be performed original file content may be read in this mode if the file does not exist, notfounderror is thrown rw - read and write mode file position indicator is initially set to the beginning of the file and may be changed with seek operations original file content may be read or modified in this mode if the file does not exist, notfounderror will be thrown rwo - read and write mode, overwriting existing file content file position indicator is initially set to the beginning of the file read and write operations may be performed original file content are deleted before opening the file if the file does not exist, it is created w - write mode file position indicator is initially set to the beginning of the file and may be changed with seek operations read operations cannot be performed original file content are deleted before opening the file if the file does not exist, it is created privilege level public privilege http //tizen org/privilege/filesystem read privilege http //tizen org/privilege/filesystem write remark write permission is needed, when file is opened in modes a, rw, rwo and w read permission is needed, when file is opened in modes r, rw and rwo parameters path path to the file openmode mode in which the file is to be opened makeparents [optional] flag indicating whether lacking directories should be created for instance, if method is invoked with parameter path equal to documents/path/to/dir/file ext and there is no directory "path" in "documents" virtual root, directories "path", "to" and "dir" will be created, as well as the new file "file ext" by default, makeparents is equal to true its value is ignored, when openmode is r or rw return value filehandle object representing open file exceptions webapiexception with error type ioerror, if a file is not available for open or any other io error occurs with error type notfounderror, if the path does not point to an existing file with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; console log "file opened for writing" ; filehandlewrite writestring "lorem ipsum dolor sit amet " ; console log "string has been written to the file" ; filehandlewrite close ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; console log "file opened for reading" ; var filecontent = filehandleread readstring ; console log "file content " + filecontent ; filehandleread close ; output example file opened for writing string has been written to the file file opened for reading file content lorem ipsum dolor sit amet createdirectory creates directory pointed by path void createdirectory path path, optional boolean makeparents, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful directory creation invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if any of the input/output error occurs notfounderror, if directory given in path does not exist and makeparents is set to false privilege level public privilege http //tizen org/privilege/filesystem write parameters path path to directory to create makeparents [optional] flag indicating whether lacking directories should be created for instance, if method is invoked with parameter path equal to documents/path/to/dir and there is no directory "path" in "documents" virtual root, directories "path", "to" and "dir" will be created by default, makeparents is equal to true successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during directory creation " + error message ; } function successcallback path { console log "the directory has been created, path to created directory " + path ; /* directory can now be accessed */ } try { tizen filesystem createdirectory "documents/foo_dir/bar_dir", true, successcallback, errorcallback ; } catch error { console log "directory cannot be created " + error message ; } output example the directory has been created, path to created directory documents/foo_dir/bar_dir deletefile deletes file pointed by path void deletefile path path, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful file deletion invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if any of the input/output error occurs notfounderror, if the path does not point to an existing file privilege level public privilege http //tizen org/privilege/filesystem write parameters path path to file successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during file deletion " + error message ; } function successcallback path { console log "the file has been deleted, path to the parent of deleted file " + path ; } try { tizen filesystem deletefile "documents/foo", successcallback, errorcallback ; } catch error { console log "file cannot be deleted " + error message ; } output example the file has been deleted, path to the parent of deleted file documents deletedirectory deletes directory or directory tree under the current directory pointed by path void deletedirectory path path, optional boolean recursive, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful directory deletion invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if a directory is not empty and recursive is equal to false notfounderror, if the path does not point to an existing directory privilege level public privilege http //tizen org/privilege/filesystem write parameters path a path to directory recursive [optional] flag indicating whether the deletion is recursive or not if recursive is set to true the method will delete content of a given directory recursively otherwise, the method succeeds only if the directory is empty, on other cases errorcallback is called by default, recursive is equal to true successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during directory deletion " + error message ; } function successcallback path { console log "the directory has been deleted, path to the parent of deleted directory " + path ; } try { tizen filesystem deletedirectory "documents/foo_dir", true, successcallback, errorcallback ; } catch error { console log "directory cannot be deleted " + error message ; } output example the directory has been deleted, path to the parent of deleted directory documents copyfile copies file from location pointed by sourcepath to destinationpath void copyfile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful file copying invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if any of the input/output error occurs notfounderror, if the sourcepath does not point to an existing file privilege level public privilege http //tizen org/privilege/filesystem read privilege http //tizen org/privilege/filesystem write parameters sourcepath path to file destinationpath path for copied file the path must consist of path to an existing directory concatenated with '/' and the name of new file overwrite [optional] flag indicating whether to overwrite an existing file if overwrite is set to true and file pointed by destinationpath already exists, the method will overwrite the file otherwise, if a file with conflicting name already exists errorcallback is called by default, overwrite is equal to false successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if any of the input parameters contains an invalid value for example, the sourcepath or the destinationpath is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during copy operation " + error message ; } function successcallback path { console log "the file has been copied, path to copied file " + path ; /* file copy can now be accessed */ } try { tizen filesystem copyfile "documents/foo", "documents/bar", true, successcallback, errorcallback ; } catch error { console log "copy operation cannot be performed " + error message ; } output example the file has been copied, path to copied file documents/bar copydirectory recursively copies directory pointed by sourcepath to destinationpath void copydirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 the method merges content of the directory pointed by sourcepath with content of the directory pointed by destinationpath, if exists if the directory pointed by destinationpath does not exist, it is created successful directory copying invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if a directory with conflicting name already exists and overwrite is equal to false or any of the input/output error occurs notfounderror, if the sourcepath does not point to an existing directory privilege level public privilege http //tizen org/privilege/filesystem read privilege http //tizen org/privilege/filesystem write parameters sourcepath path to directory destinationpath path for copied directory the path must consist of path to an existing directory concatenated with '/' and the name of destination directory overwrite [optional] flag indicating whether to overwrite existing content if overwrite is equal to true, the file or directory with conflicting name will be overwritten otherwise, errorcallback will be called with ioerror by default, overwrite is equal to false successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if any of the input parameters contains an invalid value for example, the sourcepath or the destinationpath is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during copy operation " + error message ; } function successcallback path { console log "the directory has been copied, path to copied directory " + path ; /* directory copy can now be accessed */ } try { tizen filesystem copydirectory "documents/foo_dir", "documents/bar_dir", true, successcallback, errorcallback ; } catch error { console log "copy operation cannot be performed " + error message ; } output example the directory has been copied, path to copied directory documents/bar_dir code example function errorcallback error { console log "an error occurred " + error message ; } function createfoodircallback { tizen filesystem createdirectory "documents/foo_dir/dir_2", true, createfilecallback, errorcallback ; } function listcallback files, path { console log "found inside " + path + " directory " ; for var i = 0; i < files length; i++ { console log files[i] ; } } function successcallback path { console log "the directory has been created and copied, path to directory " + path ; /* directory 'documents/bar_dir' content is as below */ /* documents/bar_dir/dir_1 */ /* documents/bar_dir/dir_2 */ /* documents/bar_dir/dir_1/file */ tizen filesystem listdirectory "documents/bar_dir", listcallback, errorcallback ; tizen filesystem listdirectory "documents/bar_dir/dir_1", listcallback, errorcallback ; } function createfilecallback { tizen filesystem openfile "documents/foo_dir/dir_1/file", "w" close ; try { tizen filesystem copydirectory "documents/foo_dir", "documents/bar_dir", true, successcallback, errorcallback ; } catch error { console log "copy operation cannot be performed " + error message ; } } tizen filesystem createdirectory "documents/foo_dir/dir_1", true, createfoodircallback, errorcallback ; output example the directory has been created and copied, path to directory documents/bar_dir found inside documents/bar_dir directory dir_1 dir_2 found inside documents/bar_dir/dir_1 directory file movefile moves file pointed by sourcepath to destinationpath void movefile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful file moving invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if a file with conflicting name already exists and overwrite is equal to false or any of the input/output error occurs notfounderror, if the sourcepath or destinationpath does not point to an existing file or directory privilege level public privilege http //tizen org/privilege/filesystem read privilege http //tizen org/privilege/filesystem write parameters sourcepath path to file destinationpath a destination directory path to move the file to overwrite [optional] flag indicating whether to overwrite an existing file if overwrite is set to true and file with the same name in destinationpath already exists, the method will overwrite the file otherwise, if a file with conflicting name already exists errorcallback is called by default, overwrite is equal to false successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if any of the input parameters contains an invalid value for example, the sourcepath or the destinationpath is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during move operation " + error message ; } function successcallback path { console log "the file has been moved, path to moved file " + path ; /* moved file can now be accessed */ } try { tizen filesystem movefile "documents/foo", "documents/foo_dir/", false, successcallback, errorcallback ; } catch error { console log "move operation cannot be performed " + error message ; } output example the file has been moved, path to moved file documents/foo_dir/foo movedirectory recursively moves directory pointed by sourcepath to destinationpath void movedirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 the method merges content of the directory pointed by sourcepath with content of the directory with the same name in destinationpath, if exists successful directory moving invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if a directory with conflicting name already exists and overwrite is equal to false or any of the input/output error occurs notfounderror, if the sourcepath or destinationpath does not point to an existing directory privilege level public privilege http //tizen org/privilege/filesystem read privilege http //tizen org/privilege/filesystem write parameters sourcepath a path to directory destinationpath a destination directory path to move the directory to overwrite [optional] flag indicating whether to overwrite existing content if overwrite is equal to true, the file or directory with conflicting name will be overwritten otherwise, errorcallback will be called with ioerror by default, overwrite is equal to false successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if any of the input parameters contains an invalid value for example, the sourcepath or the destinationpath is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during move operation " + error message ; } function successcallback path { console log "the directory has been moved, path to moved directory " + path ; /* moved directory can now be accessed */ } try { tizen filesystem movedirectory "documents/foo_dir", "documents/bar_dir/", false, successcallback, errorcallback ; } catch error { console log "move operation cannot be performed " + error message ; } output example the directory has been moved, path to moved directory documents/bar_dir/foo_dir rename renames file or directory located in path to name newname void rename path path, domstring newname, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful renaming invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if a file or a directory with conflicting name already exists or any of the input/output error occurs notfounderror, if the path does not point to an existing file or directory privilege level public privilege http //tizen org/privilege/filesystem write parameters path a path to directory or file newname a new name of directory or file successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if the path or newname is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during rename operation " + error message ; } function successcallback path { console log "the file has been renamed, path to renamed file or directory " + path ; } try { tizen filesystem rename "documents/foo", "bar", successcallback, errorcallback ; } catch error { console log "rename operation cannot be performed " + error message ; } output example the file has been renamed, path to renamed file or directory documents/bar listdirectory lists directory content located in path void listdirectory path path, listdirectorysuccesscallback successcallback, optional errorcallback? errorcallback, optional filefilter? filter ; since 5 0 successful listing of directory content invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified if the filter is passed and contains valid values, only those directories or files in the directory that match the filter criteria specified in the filefilter interface are returned in successcallback method if the filter is null or undefined the implementation must return the full list of files in the directory if the directory does not contain any files or directories, or the filter criteria do not match with any files or directories, the successcallback is invoked with an empty array the errorcallback is launched with these error types ioerror, if any of the input/output error occurs notfounderror, if the path does not point to an existing directory privilege level public privilege http //tizen org/privilege/filesystem read parameters path a path to directory successcallback callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs filter [optional] [nullable] filter to restrict the listed files exceptions webapiexception with error type invalidvalueserror, if any of the input parameters contains an invalid value for example, the path is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during directory listing " + error message ; } function successcallback files, path { console log "found directories in " + path + " directory " ; for var i = 0; i < files length; i++ { console log files[i] ; } } try { var start = new date "jan 01 2018 00 00 00" ; tizen filesystem listdirectory "documents/", successcallback, errorcallback, {name "foo_%", isdirectory true, startmodified start} ; } catch error { console log "directory listing cannot be performed " + error message ; } output example found directories in documents/ directory foo_dir_c foo_dir_b foo_dir_d foo_dir_a touri converts path to file uri domstring touri path path ; since 5 0 remark the function does not check if path exists in filesystem parameters path a path to a file or a directory return value domstring file uri for given path exceptions webapiexception with error type invalidvalueserror, if the path is invalid code example var path1 = tizen filesystem touri "documents/directory/file ext" ; var path2 = tizen filesystem touri "/opt/usr/home/owner/content/documents/directory/file ext" ; var path3 = tizen filesystem touri "file ///opt/usr/home/owner/content/documents/directory/file ext" ; /* all above paths point to the same file */ console log path1 ; console log path2 ; console log path3 ; var mmcpath = tizen filesystem touri "removable_sda1/documents/directory/file" ; console log mmcpath ; output example file ///opt/usr/home/owner/content/documents/directory/file ext file ///opt/usr/home/owner/content/documents/directory/file ext file ///opt/usr/home/owner/content/documents/directory/file ext file ///opt/media/usbdrivea1/documents/directory/file isfile checks if given path points to a file boolean isfile path path ; since 5 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters path a path to be tested return value boolean true if path points to a file, false otherwise exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type ioerror, if any of the input/output error occurs with error type notfounderror, if the path does not point to an existing file or directory with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example console log "documents/foo_file is " + tizen filesystem isfile "documents/foo_file" ? "file" "directory" ; output example documents/foo_file is file isdirectory checks if given path points to a directory boolean isdirectory path path ; since 5 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters path a path to be tested return value boolean true if path points to a directory, false otherwise exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type ioerror, if any of the input/output error occurs with error type notfounderror, if the path does not point to an existing file or directory with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example console log "documents/foo_dir is " + tizen filesystem isdirectory "documents/foo_dir" ? "directory" "file" ; output example documents/foo_dir is directory pathexists checks if given path exists boolean pathexists path path ; since 5 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters path a path to be tested return value boolean true if path points to a existing element, false otherwise exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type ioerror, if input/output error occurs with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example console log "documents/foo " + tizen filesystem pathexists "documents/foo" ? "exists" "does not exist" ; output example documents/foo does not exist getdirname returns path to directory for given path domstring getdirname domstring path ; since 5 0 strips trailing '/', then breaks path into two components by last path separator, returns first component remark this function does not check if path is valid or exists in filesystem parameters path path to file or directory return value domstring path to directory for given path code example console log tizen filesystem getdirname "/home/owner/media/documents" ; output example "/home/owner/media" resolve resolves a location to a file handle after validating it deprecated since 5 0 void resolve domstring location, filesuccesscallback onsuccess, optional errorcallback? onerror, optional filemode? mode ; since 1 0 a location can contain a virtual path like "documents/some_file txt" or a file uri like "file ///my_strange_path/some_file png" a location is not allowed to contain the " " or " " directory entries inside its value the list of root locations that must be supported by a compliant implementation are documents - the default folder in which text documents such as pdf, doc are stored by default in a device for example, in some platforms it corresponds to the "my documents" folder images - the default folder in which still images, like pictures in formats including jpg, gif, png, etc , are stored in the device by default for example, in some platforms it corresponds to the "my images" folder music - the default folder in which sound clips in formats including mp3, aac, etc are stored in the device by default for example, in some platforms it corresponds to the "my music" folder videos - the default folder in which video clips in formats including avi, mp4, etc are stored in the device by default for example, in some platforms it corresponds to the "my videos" folder downloads - the default folder in which downloaded files from sources including browser, e-mail client, etc are stored by default in the device for example, in some platforms it corresponds to the "downloads" folder ringtones - the default folder in which ringtones such as mp3, etc are stored in the device camera - the default folder in which pictures and videos taken by a device are stored wgt-package - the read-only folder to which the content of a widget file is extracted wgt-private - the private folder in which a widget stores its information this folder must be accessible only to the same widget and other widgets or applications must not be able to access the stored information wgt-private-tmp - temporary, the private folder in which a widget can store data that is available during a widget execution cycle content of this folder can be removed from this directory when the widget is closed or the web runtime is restarted this folder must be accessible only to the same widget and other widgets or applications must not be able to access it the mode parameter specifies whether the resulting file object has read-only access r access , read and write access rw access , append access a access , or write access w access to the root location containing directory tree permission for the requested access is obtained from the security framework once the resulting file object has access, access is inherited by any other file objects that are derived from this instance without any further reference to the security framework, as noted in descriptions of certain methods of file the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value for example, the mode is w for the read-only virtual roots wgt-package and ringtones notfounderror - if the location input argument does not correspond to a valid location unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read remark camera location is supported since tizen 2 3 if a device does not support camera, notsupportederror will be thrown parameters location location to resolve that can be a virtual path or file uri onsuccess callback method to be invoked when the location has been successfully resolved, passing the newly created file object onerror [optional] [nullable] callback method to be invoked when an error has occurred mode [optional] [nullable] optional value to indicate the file access mode on all files and directories that can be reached from the file object passed to onsuccess default value of this parameter is rw if absent or null exceptions webapiexception with error type notsupportederror, if this feature is not supported e g in the case of "camera" virtual path if the device does not support camera , or if mode has been set to "rwo", which was introduced in tizen version 5 0 with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example tizen filesystem resolve "images", function dir { console log "images are stored in " + dir path ; }, function e { console log "error " + e message ; }, "r" ; getstorage gets information about a storage based on its label for example "mythumbdrive", "internalflash" void getstorage domstring label, filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror ; since 1 0 the onsuccess method receives the data structure as an input argument containing additional information about the drive the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value notfounderror - if no drive was found with the given label unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read parameters label storage label onsuccess callback method to be invoked when the list of storages is available, passing the storage list to the callback onerror [optional] [nullable] callback method to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example function onstorage storage { /* do something */ } function onstorageerror e { console log "storage not found " + e message ; } tizen filesystem getstorage "music", onstorage, onstorageerror ; liststorages lists the available storages both internal and external on a device the onsuccess method receives a list of the data structures as input argument containing additional information about each drive found it can get storages that would have a label named as "internal0", virtual roots images, documents, , "removable1", "removable2" "removable1" label is used to resolve sdcard and "removable2" label is used to resolve usb host, if supported the vfat filesystem used to sdcard filesystem widely is not case-sensitive if you want to handle the file on sdcard, you need to consider case-sensitive filenames are regarded as same name void liststorages filesystemstoragearraysuccesscallback onsuccess, optional errorcallback? onerror ; since 1 0 labels can differ depending on platform implementation the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read parameters onsuccess callback method to be invoked when a list of storage is available and passing the storage list to the callback onerror [optional] [nullable] callback method to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example function alertforcorruptedremovabledrives storages { for var i = 0; i < storages length; i++ { if storages[i] type != "external" continue; if storages[i] state == "unmountable" console log "external drive " + storages[i] label + " is corrupted " ; } } tizen filesystem liststorages alertforcorruptedremovabledrives ; addstoragestatechangelistener adds a listener to subscribe to notifications when a change in storage state occurs long addstoragestatechangelistener filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror ; since 1 0 the most common usage for this method is to watch for any additions and removals of external storages when executed, it returns a subscription identifier that identifies the watch operation after returning the identifier, the watch operation is started asynchronously the onsuccess method will be invoked every time a storage state changes if the attempt fails, the onerror if present will be invoked with the relevant error type the watch operation must continue until the removestoragestatechangelistener method is called with the corresponding subscription identifier privilege level public privilege http //tizen org/privilege/filesystem write parameters onsuccess callback method to be invoked when any change is made to storage state onerror [optional] [nullable] callback method to be invoked when an error occurs during the watch process return value long subscription identifier exceptions webapiexception with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type unknownerror, if any other error occurs code example var watchid; function onstoragestatechanged storage { if storage state == "mounted" console log "storage " + storage label + " was added!" ; } watchid = tizen filesystem addstoragestatechangelistener onstoragestatechanged ; removestoragestatechangelistener removes a listener to unsubscribe from a storage watch operation void removestoragestatechangelistener long watchid ; since 1 0 if the watchid argument is valid and corresponds to a subscription already in place, the watch process will be stopped and no further callbacks will be invoked otherwise, the method call has no effect privilege level public privilege http //tizen org/privilege/filesystem write parameters watchid subscription identifier exceptions webapiexception with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges with error type unknownerror, if any other error occurs code example var watchid; function onstoragestatechanged storage { if storage state == "mounted" console log "storage " + storage label + " was added!" ; tizen filesystem removestoragestatechangelistener watchid ; } watchid = tizen filesystem addstoragestatechangelistener onstoragestatechanged ; 2 3 filesystemstorage the filesystemstorage interface gives additional information about a storage, such as if the device is mounted, if it is a removable drive or not, or the device's name [nointerfaceobject] interface filesystemstorage { readonly attribute domstring label; readonly attribute filesystemstoragetype type; readonly attribute filesystemstoragestate state; }; since 1 0 to retrieve the mount point, the resolve method should be used using the label as argument attributes readonly domstring label the storage name this attribute is used as an input for methods such as getstorage and also used as location parameter for file resolve and filesystemmanager resolve since 1 0 readonly filesystemstoragetype type the storage type as internal or external since 1 0 readonly filesystemstoragestate state the storage state as mounted or not since 1 0 2 4 filehandle object representing file, used for read/write operations [nointerfaceobject] interface filehandle { readonly attribute path path; long long seek long long offset, optional baseseekposition whence raises webapiexception ; void seeknonblocking long long offset, optional seeksuccesscallback? onsuccess, optional errorcallback? onerror, optional baseseekposition whence raises webapiexception ; domstring readstring optional long long? count, optional domstring inputencoding raises webapiexception ; void readstringnonblocking optional readstringsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long count, optional domstring inputencoding raises webapiexception ; long long writestring domstring inputstring, optional domstring outputencoding raises webapiexception ; void writestringnonblocking domstring inputstring, optional writestringsuccesscallback? onsuccess, optional errorcallback? onerror, optional domstring outputencoding raises webapiexception ; blob readblob optional long long size raises webapiexception ; void readblobnonblocking optional readblobsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size raises webapiexception ; void writeblob blob blob raises webapiexception ; void writeblobnonblocking blob blob, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; uint8array readdata optional long long size raises webapiexception ; void readdatanonblocking optional readdatasuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size raises webapiexception ; void writedata uint8array data raises webapiexception ; void writedatanonblocking uint8array data, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void flush raises webapiexception ; void flushnonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void sync raises webapiexception ; void syncnonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void close raises webapiexception ; void closenonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; }; since 5 0 each read or write operation moves position in file forwards to the end of read/written data there is an underlying file position's indicator remark due to multibyte utf-8 encoding, if current file's pointer does not point to beginning of multibyte sequence see utf-16, emoji , using seek combined with utf-8 readstring will result in string starting from valid character incomplete byte sequence at the beginning may be omitted be aware about using seek and write methods together it can result in writing in the middle of multibyte sequence, which can lead to file with corrupted content attributes readonly path path path, as passed to openfile since 5 0 methods seek sets position indicator in file stream to offset long long seek long long offset, optional baseseekposition whence ; since 5 0 note, that current position indicator value, can be obtained by calling seek 0, "current" parameters offset number of bytes to shift the position relative to whence whence [optional] determines position in file stream to which offset is added default value "begin" return value long long file position indicator exceptions webapiexception with error type ioerror, if seek fails or any error related to file handle occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example var datatowrite = new uint8array [11, 21, 31, 44, 55, 66, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedata datatowrite ; filehandlewrite close ; console log "data has been written" ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var firstthreebytes = filehandleread readdata 3 ; console log "first three bytes " + firstthreebytes ; var position = filehandleread seek -3, "end" ; /* moving to position three bytes to the end of file */ var lastthreebytes = filehandleread readdata 3 ; console log "last three bytes " + lastthreebytes ; filehandleread seek 3, "begin" ; /* moving to position at third byte */ var bytesbetween = filehandleread readdata position - 3 ; console log "bytes between " + bytesbetween ; filehandleread close ; output example data has been written first three bytes 11,21,31 last three bytes 71,81,91 bytes between 44,55,66 seeknonblocking sets position indicator in file stream to offset void seeknonblocking long long offset, optional seeksuccesscallback? onsuccess, optional errorcallback? onerror, optional baseseekposition whence ; since 5 0 successful seek operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if any error related to file handle occurs note, that current position indicator value, can be obtained in seeksuccesscallback by calling seeknonblocking 0, "current" seeknonblocking is executed in background and does not block further instructions parameters offset number of bytes to shift the position relative to whence onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs whence [optional] determines position in file stream to which offset is added default value "begin" exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writestringnonblocking "lorem ipsum dolor sit amet ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; /* moving to position 3 bytes to the end of file to alter three dots " " */ filehandlewrite seeknonblocking -3, function new_position { console log "moved to position " + new_position ; }, function error { console log error ; }, "end" ; filehandlewrite writestringnonblocking ", consectetur adipiscing elit ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; /* moving to position 3 bytes to the end of file to alter three dots " " */ filehandlewrite seeknonblocking -3, function new_position { console log "moved to position " + new_position ; }, function error { console log error ; }, "end" ; filehandlewrite writestringnonblocking ", sed do eiusmod ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; /* readstringsuccesscallback should be executed */ filehandleread readstringnonblocking function output { console log "file content " + output ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example number of bytes written 29 moved to position 26 number of bytes written 32 moved to position 55 number of bytes written 19 file handle closed file content lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod file handle closed readstring reads file content as string domstring readstring optional long long? count, optional domstring inputencoding ; since 5 0 sets file handle position indicator at the end of read data reads given number of characters remark resulting string can have length larger than count, due to possible utf-16 surrogate pairs in it string length in javascript is counted in utf-16 encoding, so for example string containing one emoji surrogate of two utf-16 character will have length of two parameters count [optional] [nullable] number of characters to read from file if none is given, method attempts to read whole file inputencoding [optional] default value "utf-8" encoding to use for read operation on the file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin-1 encoding return value domstring string with data read from file exceptions webapiexception with error type invalidvalueserror if given count exceeds maximum value supported by the device with error type ioerror, if read fails or any error related to file handle occurs with error type notsupportederror, if the given encoding is not supported with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; console log "file opened for writing" ; filehandlewrite writestring "lorem ipsum dolor sit amet " ; console log "string has been written to the file" ; filehandlewrite close ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; console log "file opened for reading" ; var filecontent = filehandleread readstring ; console log "file content " + filecontent ; filehandleread close ; output example file opened for writing string has been written to the file file opened for reading file content lorem ipsum dolor sit amet readstringnonblocking reads file content as string void readstringnonblocking optional readstringsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long count, optional domstring inputencoding ; since 5 0 reads given number of characters sets file handle position indicator at the end of read data readstringnonblocking is executed in background and does not block further instructions successful read operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if read fails or any error related to file handle occurs parameters onsuccess [optional] [nullable] callback function with read data from file to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs count [optional] number of characters to read from file if none is given, method attempts to read whole file inputencoding [optional] default value "utf-8" encoding to use for read operation on the file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin-1 encoding exceptions webapiexception with error type invalidvalueserror if given count exceeds maximum value supported by the device with error type notsupportederror, if the given encoding is not supported with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; console log "file opened for writing" ; filehandlewrite writestringnonblocking "lorem ipsum dolor sit amet ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; /* readstringsuccesscallback should be executed */ filehandleread readstringnonblocking function output { console log "file content " + output ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example file opened for writing number of bytes written 29 file handle closed file content lorem ipsum dolor sit amet file handle closed writestring writes inputstring content to a file long long writestring domstring inputstring, optional domstring outputencoding ; since 5 0 sets file handle position indicator at the end of written data parameters inputstring string value to be written to a file outputencoding [optional] default value utf-8 encoding to use for write operation on the file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin-1 encoding return value long long number of bytes written can be more than inputstring length for multibyte encodings and will never be less exceptions webapiexception with error type ioerror, if input/output error occurs with error type notsupportederror, if the given encoding is not supported code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; console log "file opened for writing" ; filehandlewrite writestring "lorem ipsum dolor sit amet " ; console log "string has been written to the file" ; filehandlewrite close ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; console log "file opened for reading" ; var filecontent = filehandleread readstring ; console log "file content " + filecontent ; filehandleread close ; output example file opened for writing string has been written to the file file opened for reading file content lorem ipsum dolor sit amet writestringnonblocking writes inputstring content to a file void writestringnonblocking domstring inputstring, optional writestringsuccesscallback? onsuccess, optional errorcallback? onerror, optional domstring outputencoding ; since 5 0 sets file handle position indicator at the end of written data writestringnonblocking is executed in background and does not block further instructions successful write operation invokes successcallback function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if write fails or any error related to file handle occurs parameters inputstring string value to be written to a file onsuccess [optional] [nullable] callback function with a number of bytes written as parameter to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs outputencoding [optional] default value "utf-8" encoding to use for write operation on the file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin-1 encoding exceptions webapiexception with error type notsupportederror, if the given encoding is not supported with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writestringnonblocking "lorem ipsum dolor sit amet ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; /* readstringsuccesscallback should be executed */ filehandleread readstringnonblocking function output { console log "file content " + output ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example number of bytes written 29 file handle closed file content lorem ipsum dolor sit amet file handle closed readblob reads file content as blob blob readblob optional long long size ; since 5 0 sets file handle position indicator at the end of read data parameters size [optional] size in bytes of data to read from file if none is given, method attempts to read whole file return value blob blob object with file content exceptions webapiexception with error type invalidvalueserror if given size exceeds maximum value supported by the device with error type ioerror, if read fails or any error related to file handle occurs code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; var b = new blob ["lorem ipsum dolor sit amet "], {type "text/plain"} ; filehandlewrite writeblob b ; filehandlewrite close ; console log "blob content has been written to file" ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var filecontentinblob = filehandleread readblob ; filehandleread close ; const reader = new filereader ; /* event fires after the blob has been read/loaded */ reader onloadend = function content { const text = content srcelement result; console log "file content " + text ; }; /* starts reading the blob as text */ reader readastext filecontentinblob ; output example blob content has been written to file file content lorem ipsum dolor sit amet readblobnonblocking reads file content as blob void readblobnonblocking optional readblobsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size ; since 5 0 sets file handle position indicator at the end of read data readblobnonblocking is executed in background and does not block further instructions successful read operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if read fails or any error related to file handle occurs parameters onsuccess [optional] [nullable] callback function with blob object to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs size [optional] [nullable] size in bytes of data to read from file if none is given, method attempts to read whole file exceptions webapiexception with error type invalidvalueserror if given size exceeds maximum value supported by the device with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; var b = new blob ["lorem ipsum dolor sit amet "], {type "text/plain"} ; filehandlewrite writeblobnonblocking b, function { console log "blob content has been written to file" ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; /* creation of a reader capable of extracting blob content */ const reader = new filereader ; /* event fires after the blob has been read/loaded */ reader onloadend = function content { const text = content srcelement result; console log "file content " + text ; }; function readblobcallback filecontentinblob { reader readastext filecontentinblob ; } /* readblobcallback should be executed */ filehandleread readblobnonblocking readblobcallback, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example blob content has been written to file file handle closed file handle closed file content lorem ipsum dolor sit amet writeblob writes blob to file void writeblob blob blob ; since 5 0 sets file handle position indicator at the end of written data parameters blob object of type blob, which content will be written to a file exceptions webapiexception with error type ioerror, if write fails or any error related to file handle occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; var b = new blob ["lorem ipsum dolor sit amet "], {type "text/plain"} ; filehandlewrite writeblob b ; filehandlewrite close ; console log "blob content has been written to file" ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var filecontentinblob = filehandleread readblob ; filehandleread close ; console log "file content has been read from file" ; const reader = new filereader ; /* event fires after the blob has been read/loaded */ reader onloadend = function content { const text = content srcelement result; console log "file content " + text ; }; /* starts reading the blob as text */ reader readastext filecontentinblob ; output example blob content has been written to file file content has been read from file file content lorem ipsum dolor sit amet writeblobnonblocking writes blob to file void writeblobnonblocking blob blob, optional successcallback? onsuccess, optional errorcallback? onerror ; since 5 0 sets file handle position indicator at the end of written data writeblobnonblocking is executed in background and does not block further instructions successful write operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if write fails or any error related to file handle occurs parameters blob object of type blob, which content will be written to a file onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; var b = new blob ["lorem ipsum dolor sit amet "], {type "text/plain"} ; filehandlewrite writeblobnonblocking b, function { console log "blob content has been written to file" ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; /* creation of a reader capable of extracting blob content */ const reader = new filereader ; /* event fires after the blob has been read/loaded */ reader onloadend = function content { const text = content srcelement result; console log "file content " + text ; }; function readblobcallback filecontentinblob { reader readastext filecontentinblob ; } /* readblobcallback should be executed */ filehandleread readblobnonblocking readblobcallback ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example blob content has been written to file file handle closed file handle closed file content lorem ipsum dolor sit amet readdata reads file content as binary data uint8array readdata optional long long size ; since 5 0 can be used in combination with atob or btoa functions sets file handle position indicator at the end of read data parameters size [optional] size in bytes of data to read from file if none is given, method attempts to read whole file return value uint8array read data as uint8array exceptions webapiexception with error type invalidvalueserror if given size exceeds maximum value supported by the device with error type ioerror, if read fails or any error related to file handle occurs code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedata datatowrite ; filehandlewrite close ; console log "data has been written" ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var filecontentinuint8array = filehandleread readdata ; filehandleread close ; console log "data read from file " + filecontentinuint8array ; output example data has been written data read from file 11,21,31,71,81,91 readdatanonblocking reads file content as binary data void readdatanonblocking optional readdatasuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size ; since 5 0 can be used in combination with atob or btoa functions sets file handle position indicator at the end of read data readdatanonblocking is executed in background and does not block further instructions successful read operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if read fails or any error related to file handle occurs parameters onsuccess [optional] [nullable] callback function with read data from file to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs size [optional] [nullable] size in bytes of data to read from file if none is given, method attempts to read whole file exceptions webapiexception with error type invalidvalueserror if given size exceeds maximum value supported by the device with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedatanonblocking datatowrite, function dataread { console log "write done" ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; filehandleread readdatanonblocking function dataread { console log "data read from file " + dataread ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example write done file handle closed data read from file 11,21,31,71,81,91 file handle closed writedata writes binary data to file void writedata uint8array data ; since 5 0 can be used in combination with atob or btoa functions sets file handle position indicator at the end of written data parameters data an array of type uint8array, which content will be written to file as binary data exceptions webapiexception with error type ioerror, if write fails or any error related to file handle occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedata datatowrite ; filehandlewrite close ; console log "data has been written" ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var filecontentinuint8array = filehandleread readdata ; filehandleread close ; console log "data read from file " + filecontentinuint8array ; output example data has been written data read from file 11,21,31,71,81,91 writedatanonblocking writes binary data to file void writedatanonblocking uint8array data, optional successcallback? onsuccess, optional errorcallback? onerror ; since 5 0 can be used in combination with atob or btoa functions sets file handle position indicator at the end of written data writedatanonblocking is executed in background and does not block further instructions successful write operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if write fails or any error related to file handle occurs parameters data an array of type uint8array, which content will be written to file as binary data onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedatanonblocking datatowrite, function dataread { console log "write done" ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; filehandleread readdatanonblocking function dataread { console log "data read from file " + dataread ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example write done file handle closed data read from file 11,21,31,71,81,91 file handle closed flush flushes data void flush ; since 5 0 for file handles with permission to write, flush writes any changes made to file content to underlying buffer flush does not ensure that data is written on storage device, it only synchronizes ram with file descriptor to ensure storage synchronization use sync, close or their asynchronous equivalent methods, which guarantee such synchronization exceptions webapiexception with error type ioerror, if flush fails or any error related to file handle occurs code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; var filehandleread = tizen filesystem openfile "documents/file", "r" ; filehandlewrite writestring "lorem ipsum dolor sit amet " ; console log "data has been written to file" ; /* calling flush ensures that content has been written to file descriptor and can be read by any */ /* process */ filehandlewrite flush ; console log "data has been flushed to system file buffer and now can be read" ; var filecontent = filehandleread readstring ; console log "read data " + filecontent ; filehandlewrite close ; filehandleread close ; output example data has been written to file data has been flushed to system file buffer and now can be read read data lorem ipsum dolor sit amet flushnonblocking flushes data void flushnonblocking optional successcallback? onsuccess, optional errorcallback? onerror ; since 5 0 for file handles with permission to write, flush writes any changes made to file content to underlying buffer flush does not ensure that data is written on storage device, it only synchronizes ram with file descriptor to ensure storage synchronization use sync, close or their asynchronous equivalent methods, which guarantee such synchronization successful flushing invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if flush fails or any error related to file handle occurs this method is asynchronous its execution will occur in background and after all previously commissioned background jobs will finish parameters onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writestringnonblocking "lorem ipsum dolor sit amet ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; /* calling flushnonblocking ensures that content will be written to file descriptor */ /* and can be read by any process */ filehandlewrite flushnonblocking function { console log "data has been flushed to system file buffer and now can be read" ; }, function error { console log error ; } ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; filehandleread readstringnonblocking function output { console log "file content " + output ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example number of bytes written 29 data has been flushed to system file buffer and now can be read file content lorem ipsum dolor sit amet file handle closed file handle closed sync synchronizes data to storage device void sync ; since 5 0 the sync function is intended to force a physical write of data from the buffer cache and to assure that after a system crash or other failure that all data up to the time of the sync call is recorded on the disk exceptions webapiexception with error type ioerror, if sync fails or any error related to file handle occurs code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedata datatowrite ; /* calling sync forces a physical write of data, so it is safe */ /* even after system crash or power shut down */ filehandlewrite sync ; console log "data has been synced" ; /* close method provides the same functionality as sync and ends access to file */ filehandlewrite close ; output example data has been synced **syncnonblocking ** synchronizes data to storage device void syncnonblocking optional successcallback? onsuccess, optional errorcallback? onerror ; since 5 0 the syncnonblocking function is intended to force a physical write of data from the buffer cache and to assure that after a system crash or other failure that all data up to the time of the syncnonblocking execution is recorded on the disk successful syncing invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if sync fails or any error related to file handle occurs this method is asynchronous its execution will occur in background and after all previously commissioned background jobs will finish parameters onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedatanonblocking datatowrite, function dataread { console log "write done" ; }, function error { console log error ; } ; /* calling syncnonblocking will force a physical write of data, so it will be safe */ /* even after system crash or power shut down */ filehandlewrite syncnonblocking function { console log "data has been synced" ; }, function error { console log error ; } ; /* close method provides the same functionality as sync and ends access to file */ filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example write done data has been synced file handle closed close closes file handle void close ; since 5 0 closes the given file stream closing file guarantees writing changes made to filehandle to the storage device further operations on this file handle are not allowed remark this method is synchronous if any asynchronous method was called before close, close will block further instructions until all background jobs finish execution note, that if file handle functions are put into any callbacks and this callback was not yet called, synchronous close will wait only for already ordered background jobs to finish, preventing successful execution of any further operations on closed file handle exceptions webapiexception with error type ioerror, if close fails or any error related to file handle occurs code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writestring "lorem ipsum dolor sit amet " ; filehandlewrite close ; console log "string has been written to the file" ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var positionoffileend = filehandleread seek 0, "end" ; console log "seek operation done position of file end " + positionoffileend ; filehandleread close ; console log "file is now closed" ; output example string has been written to the file seek operation done position of file end 29 file is now closed closenonblocking closes file handle void closenonblocking optional successcallback? onsuccess, optional errorcallback? onerror ; since 5 0 closes the given file stream closing file guarantees writing changes made to filehandle to the storage device further operations on this file handle are not allowed successful closing invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if close fails or any error related to file handle occurs this method is asynchronous its execution will occur in background and after all previously commissioned background jobs will finish parameters onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writestringnonblocking "lorem ipsum dolor sit amet ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var positionoffileend = filehandleread seeknonblocking 0, function new_position { console log "moved to position " + new_position ; }, function error { console log error ; }, "end" ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example number of bytes written 29 file handle closed moved to position 29 file handle closed 2 5 file the file interface represents the file abstraction in use deprecated since 5 0 [nointerfaceobject] interface file { readonly attribute file? parent; readonly attribute boolean readonly; readonly attribute boolean isfile; readonly attribute boolean isdirectory; readonly attribute date? created; readonly attribute date? modified; readonly attribute domstring path; readonly attribute domstring name; readonly attribute domstring fullpath; readonly attribute unsigned long long filesize; readonly attribute long length; domstring touri raises webapiexception ; void listfiles filearraysuccesscallback onsuccess, optional errorcallback? onerror, optional filefilter? filter raises webapiexception ; void openstream filemode mode, filestreamsuccesscallback onsuccess, optional errorcallback? onerror, optional domstring? encoding raises webapiexception ; void readastext filestringsuccesscallback onsuccess, optional errorcallback? onerror, optional domstring? encoding raises webapiexception ; void copyto domstring originfilepath, domstring destinationfilepath, boolean overwrite, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void moveto domstring originfilepath, domstring destinationfilepath, boolean overwrite, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; file createdirectory domstring dirpath raises webapiexception ; file createfile domstring relativefilepath raises webapiexception ; file resolve domstring filepath raises webapiexception ; void deletedirectory domstring directorypath, boolean recursive, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void deletefile domstring filepath, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; }; since 1 0 the file object permissions for the file object location and tree rooted at that location depend upon the mode defined in the resolve method when a file object creates a child file object, the new file object inherits its access rights from the parent object without any reference to the security framework, as noted in certain methods of file a file handle represents either a file or a directory for a file, the isfile attribute is set to true for a directory, the isdirectory attribute is set to true a file can be opened for both read and write operations, using a filestream handle a list of files and sub-directories can be obtained from a directory and a resolve method exists to resolve files or sub-directories more conveniently than processing directory listings a file handle representing a file can be opened for i/o operations, such as reading and writing a file handle representing a directory can be used for listing all files and directories rooted as the file handle location code example function onsuccess files { for var i = 0; i < files length; i++ { /* alerts each name of dir's content */ console log files[i] name ; } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } /* list directory content */ dir listfiles onsuccess, onerror ; attributes readonly file parent [nullable] the parent directory handle deprecated since 5 0 this attribute is set to null if there is no parent directory this also implies that this directory represents a root location since 1 0 code example /* list directory content */ dir listfiles onsuccess, onerror ; function onsuccess files { for var i = 0; i < files length; i++ { /* prints the file parent, must contain the */ /* same value for all the files in the loop */ console log "all the files should have the same parent " + files[i] parent ; } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } readonly boolean readonly the file/directory access state in the filesystem deprecated since 5 0 this attribute is set to true - if object has read-only access at its location false - if object has write access at its location this attribute represents the actual state of a file or directory in the filesystem its value is not affected by the mode used in filesystemmanager resolve that was used to create the file object from which this file object was obtained since 1 0 code example /* lists directory content */ dir listfiles onsuccess, onerror ; function onsuccess files { for var i = 0; i < files length; i++ { if files[i] readonly console log "cannot write to file " + files[i] name ; else console log "can write to file " + files[i] name ; } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } readonly boolean isfile the flag indicating whether it is a file deprecated since 5 0 this attribute can have the following values true if this handle is a file false if this handle is a directory since 1 0 readonly boolean isdirectory the flag indicating whether it is a directory deprecated since 5 0 this attribute can have the following values true if this handle is a directory false if this handle is a file since 1 0 readonly date created [nullable] the timestamp when a file is first created in the filesystem deprecated since 5 0 this timestamp is equivalent to the timestamp when a call to createfile succeeds if the platform does not support this attribute, it will be null it is unspecified and platform-dependent if the creation timestamp changes when a file is moved since 1 0 readonly date modified [nullable] the timestamp when the most recent modification is made to a file, usually when the last write operation succeeds deprecated since 5 0 opening a file for reading does not change the modification timestamp if the platform does not support this attribute, it will be null it is unspecified and platform-dependent if the modified timestamp changes when a file is moved since 1 0 code example console log file modified ; /* displays the modification timestamp */ readonly domstring path the path of a file after excluding its file name deprecated since 5 0 it begins with the name of the root containing the file, followed by the path, including the directory containing the file, but excluding the file name except in some special cases of the file representing the root itself, the last character is always "/" for example, if a file is located at music/ramones/volume1/rockawaybeach mp3, the path is music/ramones/volume1/ for example, if a directory is located at music/ramones/volume1, the path is music/ramones/ for the virtual roots, the path is same as the name of the virtual root for example, if the root is music, then the path is music if the root is documents, then the path is documents since 1 0 code example console log file path ; /* must be music/ if the file is music/foo mp3 */ readonly domstring name the file name after excluding the root name and any path components deprecated since 5 0 this is the name of this file, excluding the root name and any other path components for example, if a file is located at music/ramones/volume1/rockawaybeach mp3, the name is "rockawaybeach mp3" for example, if a directory is located at music/ramones/volume1, the name is be "volume1" for the special case of the root itself, the name is an empty string since 1 0 code example /* must be foo mp3 if the file path is music/foo mp3 */ console log file name ; readonly domstring fullpath the full path of a file deprecated since 5 0 it begins with the name of the root containing the file, and including the name of the file or directory itself for instance, if the rockawaybeach mp3 file is located at music/ramones/volume1/, then the fullpath is music/ramones/volume1/rockawaybeach mp3 for a directory, if the volume1 directory is located at music/ramones/, then the fullpath is music/ramones/volume1 for the special case of the root itself, if the root is music, then the fullpath is music the fullpath is always equal to path + name since 1 0 code example /* must be music/track1 mp3 if the file is music/track1 mp3 */ console log file fullpath ; readonly unsigned long long filesize the size of this file, in bytes deprecated since 5 0 if an attempt to read this attribute for a directory is made, undefined is returned to retrieve the number of files and directories contained in the directory, use the length attribute since 1 0 code example /* displays the file size */ console log file filesize ; readonly long length the number of files and directories contained in a file handle deprecated since 5 0 if an attempt to read this attribute for a file is made, undefined is returned to retrieve the size of a file, use the filesize attribute since 1 0 code example /* "3" if the directory contains two files and one sub-directory */ console log file length ; methods touri returns a uri for a file to identify an entry such as using it as the src attribute on an html img element the uri has no specific expiration, it should be valid at least as long as the file exists deprecated since 5 0 domstring touri ; since 1 0 if that uri corresponds to any of the public virtual roots that is images, videos, music, documents and downloads the uri must be globally unique and could be used by any widget if that uri corresponds to a file located in any a widget's private areas such as wgt-package, wgt-private, wgt-private-tmp , the generated uri must be unique for that file and for the widget making the request such as including some derived from the widget id in the uri these uris must not be accessible to other widgets, apart from the one invoking this method privilege level public privilege http //tizen org/privilege/filesystem read return value domstring uri that identifies the file or null if an error occurs exceptions webapiexception with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges with error type unknownerror, if any other error occurred code example tizen filesystem resolve "music/ramones/rockawaybeach mp3", function file { var audio = new audio file touri ; audio play ; console log file touri ; } ; listfiles lists all files in a directory deprecated since 5 0 void listfiles filearraysuccesscallback onsuccess, optional errorcallback? onerror, optional filefilter? filter ; since 1 0 the list of files is passed as a file[] in onsuccess and contains directories and files however, the directories " " and " " must not be returned each file object that is part of the array must inherit all the access rights that is, one of the values in filemode from the file object in which this method is invoked if the filter is passed and contains valid values, only those directories and files in the directory that match the filter criteria specified in the filefilter interface must be returned in the onsuccess method if no filter is passed, the filter is null or undefined, or the filter contains invalid values, the implementation must return the full list of files in the directory if the directory does not contain any files or directories, or the filter criteria do not match any files or directories, the onsuccess is invoked with an empty array the errorcallback is launched with these error types ioerror - if the operation is launched on a file not a directory invalidvalueserror - if any of the input parameters contain an invalid value unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read parameters onsuccess callback method to be invoked when the list operation has been successfully completed onerror [optional] [nullable] callback method to be invoked when an error has occurred filter [optional] [nullable] criteria to restrict the listed files exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example function onsuccess files { console log "there are " + files length + " in the selected folder" ; } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "r" ; openstream opens the file in the given mode supporting a specified encoding deprecated since 5 0 void openstream filemode mode, filestreamsuccesscallback onsuccess, optional errorcallback? onerror, optional domstring? encoding ; since 1 0 this operation is performed asynchronously if the file is opened successfully, the onsuccess method is invoked with a filestream that can be used for reading and writing the file, depending on the mode the returned filestream instance includes a file pointer, which represents the current position in the file the file pointer, by default, is at the start of the file, except in the case of opening a file in append "a" mode, in which case the file pointer points to the end of the file the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value ioerror - the operation is launched on a directory not a file , the file is not valid or it does not exist unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read parameters mode mode in which the file is opened "r" for reading "a" for appending "w" for [over]writing "rw" for reading and writing onsuccess callback method to be invoked when a file has been opened onerror [optional] [nullable] callback method to be invoked when an error has occurred encoding [optional] [nullable] encoding to use for read/write operations on the file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin1 encoding if no encoding is passed by the developer, then the default platform encoding must be used exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { console log "file name is " + files[i] name ; /* displays file name */ } var testfile = documentsdir createfile "test txt" ; if testfile != null { testfile openstream "w", function fs { fs write "helloworld" ; fs close ; }, function e { console log "error " + e message ; }, "utf-8" ; } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; readastext reads the content of a file as a domstring deprecated since 5 0 void readastext filestringsuccesscallback onsuccess, optional errorcallback? onerror, optional domstring? encoding ; since 1 0 if the operation is successfully executed, the onsuccess method is invoked and a domstring is passed as input parameter that represents the file content in the format determined by the encoding parameter the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value ioerror - if the operation is launched on a directory not a file , the file is not valid, or the file does not exist unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read parameters onsuccess callback method to be invoked when a file has been successfully read onerror [optional] [nullable] callback method to be invoked when an error occurs while reading a file encoding [optional] [nullable] encoding for read/write operations on a file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin1 encoding if no encoding is passed by the developer, then the default platform encoding must be used exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { console log "file name is " + files[i] name ; /* displays file name */ if files[i] isdirectory == false { files[i] readastext function str { console log "the file content " + str ; }, function e { console log "error " + e message ; }, "utf-8" ; } } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; copyto copies and overwrites if possible and specified a file or a directory from a specified location to another specified location deprecated since 5 0 void copyto domstring originfilepath, domstring destinationfilepath, boolean overwrite, optional successcallback? onsuccess, optional errorcallback? onerror ; since 1 0 the copy of the file or directory identified by the originfilepath parameter must be created in the path passed in the destinationfilepath parameter the file or directory to copy must be under the directory from which the method is invoked, otherwise the operation must not be performed if the copy is performed successfully, the onsuccess method is invoked the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value notfounderror - if the originfilepath does not correspond to a valid file or destinationpath is not a valid path ioerror - if the file in which the copyto method is invoked is a file and not a directory , originfilepath corresponds to a file or directory in use by another process, overwrite parameter is false and destinationfilepath corresponds to an existing file or directory unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem write parameters originfilepath origin full virtual file or directory path and it must be under the current directory destinationfilepath new full virtual file path or directory path overwrite attribute to determine whether overwriting is allowed or not if set to true, it enforces overwriting an existing file onsuccess [optional] [nullable] callback method to be invoked when the file has been copied onerror [optional] [nullable] callback method to be invoked when an error has occurred exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { if files[i] isdirectory == false { documentsdir copyto files[i] fullpath, "images/backup/" + files[i] name, false, function { console log "file copied" ; } ; } } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; moveto moves and overwrites if possible and specified a file or a directory from a specified location to another this operation is different from instantiating copyto and then deleting the original file, as on certain platforms, this operation does not require extra disk space deprecated since 5 0 void moveto domstring originfilepath, domstring destinationfilepath, boolean overwrite, optional successcallback? onsuccess, optional errorcallback? onerror ; since 1 0 the file or directory identified by the originfilepath parameter is moved to the path passed in the destinationfilepath parameter the file to move must be under the directory from which the method is invoked, else the operation can not be performed if the file or directory is moved successfully, the onsuccess method is invoked the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value notfounderror - if originfilepath does not correspond to a valid file or destinationpath is not a valid path ioerror - if the file in which the moveto method is invoked is a file not a directory , originfilepath corresponds to a file or directory in use by another process, overwrite parameter is false and destinationfilepath corresponds to an existing file or directory unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem write parameters originfilepath origin full virtual file or directory path and it must be under the current directory destinationfilepath new full virtual file path or directory path overwrite flag indicating whether to overwrite an existing file when set to true, the files can be overwritten onsuccess [optional] [nullable] callback method to be invoked when the file has been moved onerror [optional] [nullable] callback method to be invoked when an error has occurred exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { if files[i] isdirectory == false { documentsdir moveto files[i] fullpath, "images/newfolder/" + files[i] name, false, function { console log "file moved" ; } ; } } } function onerror error { console log "the error " + error message + " occurred during listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; createdirectory creates a new directory deprecated since 5 0 file createdirectory domstring dirpath ; since 1 0 a new directory will be created relative to the current directory that this operation is performed on the implementation will attempt to create all necessary sub-directories specified in the dirpath, as well the use of " " or " " in path components is not supported this operation can only be performed on file handles that represent directories that is, isdirectory == true if the directory is successfully created, it will be returned in case the directory cannot be created, an error must be thrown with the appropriate error type privilege level public privilege http //tizen org/privilege/filesystem write parameters dirpath relative directory path and it only contains characters supported by the underlying filesystem return value file file handle of the new directory the new file object has "rw" access rights, as it inherits this from the file object on which the createdirectory method is called exceptions webapiexception with error type ioerror, if the dirpath already exists, if the file in which the createdirectory method is invoked is a file and not a directory with error type invalidvalueserror, if the dirpath does not contain a valid path with error type typemismatcherror, if the input parameter is not compatible with the expected type with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type unknownerror, if any other error occurs code example var dir; /* directory object obtained from filesystem api */ var newdir = dir createdirectory "newdir" ; var anothernewdir = dir createdirectory "newdir1/subnewdir1" ; createfile creates a empty new file in a specified location that is relative to the directory indicated by current file object's path attribute deprecated since 5 0 file createfile domstring relativefilepath ; since 1 0 the use of " " or " " in path components is not supported this operation can only be performed on file handlers that represent a directory that is, isdirectory == true if the file is successfully created, a file handle must be returned by this method in case the file cannot be created, an error must be thrown with the appropriate error type privilege level public privilege http //tizen org/privilege/filesystem write parameters relativefilepath new file path and it should only contain characters supported by the underlying filesystem return value file file handle for the new empty file the new file object has "rw" access rights, as it inherits this from the file object on which the createfile method is called exceptions webapiexception with error type ioerror, if relativefilepath already exists, if the file in which the createfile method is invoked is a file not a directory with error type invalidvalueserror, if relativefilepath contains an invalid value with error type typemismatcherror, if the input parameter is not compatible with the expected type with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type unknownerror, if any other error occurs code example var newfile = dir createfile "newfilepath" ; resolve resolves an existing file or directory relative to the current directory this operation is performed on and returns a file handle for it deprecated since 5 0 file resolve domstring filepath ; since 1 0 the filepath is not allowed to contain the " " or " " directory entries inside its value the encoding of file paths is utf-8 privilege level public privilege http //tizen org/privilege/filesystem read parameters filepath relative file path or file uri to resolve return value file file handle of the file the new file object inherits its access rights from the file object on which this resolve method is called exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type invalidvalueserror, if the file path contains an invalid value with error type ioerror, if the method is executed in a file object that does not represent a directory that is, isdirectory attribute is false with error type notfounderror, if a file does not exist for the passed file path with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges with error type unknownerror, if any other error occurs code example var file; /* resolves helloworld doc file that is located in the */ /* documents root location */ tizen filesystem resolve "documents", function dir { file = dir resolve "helloworld doc" ; }, function e { console log "error " + e message ; }, "rw" ; deletedirectory deletes a specified directory and directory tree if specified deprecated since 5 0 void deletedirectory domstring directorypath, boolean recursive, optional successcallback? onsuccess, optional errorcallback? onerror ; since 1 0 this method attempts to asynchronously delete a directory or directory tree under the current directory if the recursive parameter is set to true, all the directories and files under the specified directory must be deleted if the recursive parameter is set to false, the directory is only deleted if it is empty, otherwise an ioerror error type will be passed in onerror if the deletion is performed successfully, the onsuccess is invoked the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value notfounderror -if the passed directory does not correspond to a valid directory ioerror - if the file in which the delete method is invoked is a file and not a directory , the directory is in use by another process or the directory is not empty and recursive argument is false this code is also used if a recursive deletion partially fails and any data deleted so far cannot be recovered this may occur due to the lack of filesystem permissions or if any directories or files are already opened by other processes unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem write parameters directorypath full virtual path to the directory to delete must be under the current one recursive flag indicating whether the deletion is recursive or not when set to true recursive deletion is allowed also, this function deletes all data in all subdirectories and so needs to be used with caution onsuccess [optional] [nullable] callback method to be invoked when a directory is successfully deleted onerror [optional] [nullable] callback method to be invoked when an error has occurred exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { if files[i] isdirectory { documentsdir deletedirectory files[i] fullpath, false, function { console log "directory deleted" ; }, function e { console log "error " + e message ; } ; } } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; deletefile deletes a specified file this function attempts to asynchronously delete a file under the current directory deprecated since 5 0 void deletefile domstring filepath, optional successcallback? onsuccess, optional errorcallback? onerror ; since 1 0 if the deletion is performed successfully, the onsuccess is invoked the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value notfounderror - if the file does not correspond to a valid file ioerror - if the file in which the delete method is invoked is a file not a directory , the file is in use by another process, or there is no permission in the file system unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem write parameters filepath full virtual path to the file to delete must be under the current directory onsuccess [optional] [nullable] callback method to be invoked when the file is successfully deleted onerror [optional] [nullable] callback method to be invoked when an error has occurred exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { if !files[i] isdirectory { documentsdir deletefile files[i] fullpath, function { console log "file deleted" ; }, function e { console log "error " + e message ; } ; } } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; 2 6 filefilter the dictionary that defines attributes to filter the items returned by the listdirectory method or deprecated listfiles dictionary filefilter { domstring name; boolean isfile; boolean isdirectory; date startmodified; date endmodified; date startcreated; date endcreated; }; since 1 0 when this dictionary is passed to a method, the result-set of the method will only contain file item entries that match the attribute values of the filter a file item only matches the filefilter object if all of the defined filter's attribute values match all of the file item's attributes only matching values other than undefined or null this is similar to a sql's "and" operation an attribute of the file entry matches the filefilter attribute value in accordance with the following rules for filefilter attributes of type domstring, an entry matches this value only if its corresponding attribute is an exact match if the filter contains u+0025 "percent sign" it is interpreted as a wildcard character and "%" matches any string of any length, including no length if wildcards are used, the behavior is similar to the like condition in sql to specify that a "percent sign" character is to be considered literally instead of interpreting it as a wildcard, developers can escape it with the backslash character please, remember that the backslash character has to be escaped itself, to not to be removed from the string - proper escaping of the "percent sign" in javascript string requires preceding it with double backslash "%" the matching is not case sensitive, such as "foo" matches a "foo" or an "f%" filter for file entry attributes of type date, attributes start and end are included to allow filtering of file entries between two supplied dates if either or both of these attributes are specified, the following rules apply a if both start and end dates are specified that is, other than null , a file entry matches the filter if its corresponding attribute is the same as either start or end or between the two supplied dates that is, after start and before end b if only the start attribute contains a value other than null , a file entry matches the filter if its corresponding attribute is later than or equal to the start one c if only the end date contains a value other than null , a file matches the filter if its corresponding attribute is earlier than or equal to the end date dictionary members domstring name the file name attribute filter files that have a name that corresponds with this attribute either exactly or with the specified wildcards match this filtering criteria since 1 0 boolean isfile if true match only files if false do not match files may be undefined since 5 0 boolean isdirectory if true match only directories, if false do not match directories may be undefined since 5 0 date startmodified the file modified attribute filter files with modified date later than this attribute or equal to it match the filtering criteria since 1 0 date endmodified the file modified attribute filter files with modified date earlier than this attribute or equal to it match the filtering criteria since 1 0 date startcreated the file created attribute filter files with created date later than this attribute or equal to it match the filtering criteria since 1 0 date endcreated the file created attribute filter files with created date earlier than this attribute or equal to it match the filtering criteria since 1 0 2 7 filestream the filestream interface represents a handle to a file opened for read and/or write operations read and write operations are performed relative to a position attribute, which is a pointer that represents the current position in the file deprecated since 5 0 [nointerfaceobject] interface filestream { readonly attribute boolean eof; attribute long position; readonly attribute long bytesavailable; void close ; domstring read long charcount raises webapiexception ; octet[] readbytes long bytecount raises webapiexception ; domstring readbase64 long bytecount raises webapiexception ; void write domstring stringdata raises webapiexception ; void writebytes octet[] bytedata raises webapiexception ; void writebase64 domstring base64data raises webapiexception ; }; since 1 0 a series of read/write methods are available that permit both binary and text to be processed once a file stream is closed, any operation attempt made on this stream results in a standard javascript error the read/write operations in this interface do not throw any security exceptions as the access rights are expected to be granted through the initial resolve method or through the openstream method of the file interface therefore, all actions performed on a successfully resolved file and filestream are expected to succeed this avoids successive asynchronous calls and may potentially increase application for a user attributes readonly boolean eof the flag indicating whether the current file pointer is at the end of the file deprecated since 5 0 if set to true, this attribute indicates that the file pointer is at the end of the file if set to false, this attribute indicates that the file pointer is not at the end of the file and so it is anywhere within the file since 1 0 code example if stream eof { /* file has been read completely */ } long position the flag indicating the stream position for reads/writes deprecated since 5 0 the stream position is an offset of bytes from the start of the file stream when invoking an operation that reads or writes from the stream, the operation will take place from the byte defined by this position attribute if the read or write operation is successful, the position of the stream is advanced by the number of bytes read or written if the read/write operation is not successful, the position of the stream is unchanged since 1 0 code example console log stream position ; /* displays current stream position */ /* alters current stream position to the begin of the file, */ /* like seek in c */ stream position = 0; readonly long bytesavailable the number of bytes that are available for reading from the stream deprecated since 5 0 the number of bytes available for reading is the maximum amount of bytes that can be read in the next read operation it corresponds to the number of bytes available after the file pointer denoted by the position attribute -1 if eof is true since 1 0 code example console log stream bytesavailable ; /* displays the available bytes to be read */ methods close closes this filestream deprecated since 5 0 void close ; since 1 0 flushes any pending buffered writes and closes the file always succeeds note that pending writes might not succeed privilege level public privilege http //tizen org/privilege/filesystem read code example stream close ; /* closes this stream, no subsequent access to stream allowed */ read reads the specified number of characters from the position of the file pointer in a filestream and returns the characters as a string the resulting string length might be shorter than charcount if eof is true deprecated since 5 0 domstring read long charcount ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters charcount number of characters being read return value domstring array of read characters as a string exceptions webapiexception with error type ioerror, if a read error occurs, such as the bytes in the stream cannot be decoded with the encoding in use with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type invalidvalueserror, if any of the input parameters contains an invalid value with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example var text = stream read file filesize ; stream close ; readbytes reads the specified number of bytes from a filestream deprecated since 5 0 octet[] readbytes long bytecount ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters bytecount number of bytes to read return value octet[] result of read bytes as a byte or number array exceptions webapiexception with error type ioerror, if a read error occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type invalidvalueserror, if any of the input parameters contains an invalid value with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example /* reads up to 256 bytes from the stream */ var raw = stream readbytes 256 ; for var i = 0; i < raw length; i++ { /* raw[i] contains the i-th byte of the current data chunk */ } readbase64 reads the specified number of bytes from this filestream, encoding the result in base64 deprecated since 5 0 domstring readbase64 long bytecount ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters bytecount number of bytes to read return value domstring array of read characters as base64 encoding string exceptions webapiexception with error type ioerror, if a read error occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type invalidvalueserror, if any of the input parameters contains an invalid value with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example /* reads up to 256 bytes from the stream */ var base64 = stream readbase64 256 ; write writes the specified domstring to a filestream deprecated since 5 0 void write domstring stringdata ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem write parameters stringdata actual string to write exceptions webapiexception with error type ioerror, if a write error occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example var text = "hello world"; stream write text ; writebytes writes the specified bytes to this filestream deprecated since 5 0 void writebytes octet[] bytedata ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem write parameters bytedata byte data array being written exceptions webapiexception with error type ioerror, if a write error occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example var bytes = input readbytes 256 ; /* writes the bytes read from input to output */ output writebytes bytes ; writebase64 writes the result to this filestream after converting the specified base64 domstring to bytes deprecated since 5 0 void writebase64 domstring base64data ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem write parameters base64data the base64 data to written exceptions webapiexception with error type ioerror, if an error occurs during writebase64 with error type invalidvalueserror, if the input parameter contains an invalid value e g the base64data input parameter is not a valid base64 sequence with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example var base64 = input readbase64 256 ; /* writes the base64 data read from input to output */ output writebase64 base64 ; 2 8 filesuccesscallback the filesuccesscallback interface defines file system success callback with a file object as input argument deprecated since 5 0 [callback=functiononly, nointerfaceobject] interface filesuccesscallback { void onsuccess file file ; }; since 1 0 it is used in asynchronous operations, such as filesystemmanager resolve , copying, moving and deleting files methods onsuccess called when the asynchronous call completes successfully deprecated since 5 0 void onsuccess file file ; since 1 0 parameters file file resulting from the asynchronous call 2 9 filesystemstoragearraysuccesscallback the filesystemstoragearraysuccesscallback callback interface specifies a success callback with an array of filesystemstorage objects as input argument [callback=functiononly, nointerfaceobject] interface filesystemstoragearraysuccesscallback { void onsuccess filesystemstorage[] storages ; }; since 1 0 it is used in asynchronous operations, such as filesystemmanager liststorages methods onsuccess called when the asynchronous call completes successfully void onsuccess filesystemstorage[] storages ; since 1 0 parameters storages list of available storage devices 2 10 filesystemstoragesuccesscallback the filesystemstoragesuccesscallback callback interface specifies a success callback with a filesystemstorage object as input argument [callback=functiononly, nointerfaceobject] interface filesystemstoragesuccesscallback { void onsuccess filesystemstorage storage ; }; since 1 0 it is used in asynchronous operations, such as filesystemmanager getstorage and filesystemmanager addstoragestatechangelistener methods onsuccess called when the asynchronous call completes successfully void onsuccess filesystemstorage storage ; since 1 0 parameters storage storage device structure 2 11 pathsuccesscallback the pathsuccesscallback callback interface specifies a success callback with a path value as input argument [callback=functiononly, nointerfaceobject] interface pathsuccesscallback { void onsuccess path path ; }; since 5 0 it is used in asynchronous operations of the filesystemmanager interface methods onsuccess called when the asynchronous call completes successfully void onsuccess path path ; since 5 0 parameters path path to created or changed resource on the filesystem in case of deletion, path to parent of the deleted resource is given 2 12 seeksuccesscallback the seeksuccesscallback callback interface specifies a success callback with a long long value as input argument [callback=functiononly, nointerfaceobject] interface seeksuccesscallback { void onsuccess long long position ; }; since 5 0 it is used in asynchronous operation filehandle seeknonblocking methods onsuccess called when the asynchronous call completes successfully void onsuccess long long position ; since 5 0 parameters position file position indicator 2 13 readstringsuccesscallback the readstringsuccesscallback callback interface specifies a success callback with a domstring value as input argument [callback=functiononly, nointerfaceobject] interface readstringsuccesscallback { void onsuccess domstring string ; }; since 5 0 it is used in asynchronous operation filehandle readstringnonblocking methods onsuccess called when the asynchronous call completes successfully void onsuccess domstring string ; since 5 0 parameters string string with data read from file 2 14 writestringsuccesscallback the writestringsuccesscallback callback interface specifies a success callback with a long long value as input argument [callback=functiononly, nointerfaceobject] interface writestringsuccesscallback { void onsuccess long long bytescount ; }; since 5 0 it is used in asynchronous operation filehandle writestringnonblocking methods onsuccess called when the asynchronous call completes successfully void onsuccess long long bytescount ; since 5 0 parameters bytescount number of bytes written can be more than inputstring length for multibyte encodings and will never be less 2 15 readblobsuccesscallback the readblobsuccesscallback callback interface specifies a success callback with a blob object as input argument [callback=functiononly, nointerfaceobject] interface readblobsuccesscallback { void onsuccess blob blob ; }; since 5 0 it is used in asynchronous operation filehandle readblobnonblocking methods onsuccess called when the asynchronous call completes successfully void onsuccess blob blob ; since 5 0 parameters blob blob object with file content 2 16 readdatasuccesscallback the readdatasuccesscallback callback interface specifies a success callback with a uint8array value as input argument [callback=functiononly, nointerfaceobject] interface readdatasuccesscallback { void onsuccess uint8array data ; }; since 5 0 it is used in asynchronous operation filehandle readdatanonblocking methods onsuccess called when the asynchronous call completes successfully void onsuccess uint8array data ; since 5 0 parameters data a typedarray with file content 2 17 filestringsuccesscallback the filestringsuccesscallback callback interface specifies a success callback with a domstring object as input argument deprecated since 5 0 [callback=functiononly, nointerfaceobject] interface filestringsuccesscallback { void onsuccess domstring filestr ; }; since 1 0 it is used in asynchronous operation file readastext methods onsuccess called when the asynchronous call completes successfully deprecated since 5 0 void onsuccess domstring filestr ; since 1 0 parameters filestr file represented as a domstring resulting from the asynchronous call 2 18 filestreamsuccesscallback the filestreamsuccesscallback interface specifies a success callback with a filestream object as input argument deprecated since 5 0 [callback=functiononly, nointerfaceobject] interface filestreamsuccesscallback { void onsuccess filestream filestream ; }; since 1 0 it is used in asynchronous operation file openstream methods onsuccess called when the file openstream asynchronous call completes successfully deprecated since 5 0 void onsuccess filestream filestream ; since 1 0 parameters filestream filestream to access file content 2 19 listdirectorysuccesscallback the listdirectorysuccesscallback interface defines success callback for listing methods [callback=functiononly, nointerfaceobject] interface listdirectorysuccesscallback { void onsuccess domstring[] names, path path ; }; since 5 0 this callback interface specifies a success callback with a function taking an array of strings as input argument it is used in asynchronous operation filesystemmanager listdirectory methods onsuccess called when the asynchronous call completes successfully void onsuccess domstring[] names, path path ; since 5 0 parameters names file or directory names resulting from the asynchronous call path path to listed directory 2 20 filearraysuccesscallback the filearraysuccesscallback interface defines file system specific success callback for listing methods deprecated since 5 0 [callback=functiononly, nointerfaceobject] interface filearraysuccesscallback { void onsuccess file[] files ; }; since 1 0 this callback interface specifies a success callback with a function taking an array of file objects as input argument it is used in asynchronous methods, such as file listfiles methods onsuccess called when the asynchronous call completes successfully deprecated since 5 0 void onsuccess file[] files ; since 1 0 parameters files files resulting from the asynchronous call 3 full webidl module filesystem { typedef domstring path; typedef blob blob; enum filemode { "a", "r", "rw", "rwo", "w" }; enum filesystemstoragetype { "internal", "external" }; enum filesystemstoragestate { "mounted", "removed", "unmountable" }; enum baseseekposition { "begin", "current", "end" }; dictionary filefilter { domstring name; boolean isfile; boolean isdirectory; date startmodified; date endmodified; date startcreated; date endcreated; }; tizen implements filesystemmanagerobject; [nointerfaceobject] interface filesystemmanagerobject { readonly attribute filesystemmanager filesystem; }; [nointerfaceobject] interface filesystemmanager { readonly attribute long maxnamelength; readonly attribute long maxpathlength; filehandle openfile path path, filemode openmode, optional boolean makeparents raises webapiexception ; void createdirectory path path, optional boolean makeparents, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void deletefile path path, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void deletedirectory path path, optional boolean recursive, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void copyfile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void copydirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void movefile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void movedirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void rename path path, domstring newname, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void listdirectory path path, listdirectorysuccesscallback successcallback, optional errorcallback? errorcallback, optional filefilter? filter raises webapiexception ; domstring touri path path raises webapiexception ; boolean isfile path path raises webapiexception ; boolean isdirectory path path raises webapiexception ; boolean pathexists path path raises webapiexception ; domstring getdirname domstring path ; void getstorage domstring label, filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; void liststorages filesystemstoragearraysuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; long addstoragestatechangelistener filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; void removestoragestatechangelistener long watchid raises webapiexception ; }; [nointerfaceobject] interface filesystemstorage { readonly attribute domstring label; readonly attribute filesystemstoragetype type; readonly attribute filesystemstoragestate state; }; [nointerfaceobject] interface filehandle { readonly attribute path path; long long seek long long offset, optional baseseekposition whence raises webapiexception ; void seeknonblocking long long offset, optional seeksuccesscallback? onsuccess, optional errorcallback? onerror, optional baseseekposition whence raises webapiexception ; domstring readstring optional long long? count, optional domstring inputencoding raises webapiexception ; void readstringnonblocking optional readstringsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long count, optional domstring inputencoding raises webapiexception ; long long writestring domstring inputstring, optional domstring outputencoding raises webapiexception ; void writestringnonblocking domstring inputstring, optional writestringsuccesscallback? onsuccess, optional errorcallback? onerror, optional domstring outputencoding raises webapiexception ; blob readblob optional long long size raises webapiexception ; void readblobnonblocking optional readblobsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size raises webapiexception ; void writeblob blob blob raises webapiexception ; void writeblobnonblocking blob blob, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; uint8array readdata optional long long size raises webapiexception ; void readdatanonblocking optional readdatasuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size raises webapiexception ; void writedata uint8array data raises webapiexception ; void writedatanonblocking uint8array data, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void flush raises webapiexception ; void flushnonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void sync raises webapiexception ; void syncnonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void close raises webapiexception ; void closenonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; }; [callback=functiononly, nointerfaceobject] interface filesystemstoragearraysuccesscallback { void onsuccess filesystemstorage[] storages ; }; [callback=functiononly, nointerfaceobject] interface filesystemstoragesuccesscallback { void onsuccess filesystemstorage storage ; }; [callback=functiononly, nointerfaceobject] interface pathsuccesscallback { void onsuccess path path ; }; [callback=functiononly, nointerfaceobject] interface seeksuccesscallback { void onsuccess long long position ; }; [callback=functiononly, nointerfaceobject] interface readstringsuccesscallback { void onsuccess domstring string ; }; [callback=functiononly, nointerfaceobject] interface writestringsuccesscallback { void onsuccess long long bytescount ; }; [callback=functiononly, nointerfaceobject] interface readblobsuccesscallback { void onsuccess blob blob ; }; [callback=functiononly, nointerfaceobject] interface readdatasuccesscallback { void onsuccess uint8array data ; }; [callback=functiononly, nointerfaceobject] interface listdirectorysuccesscallback { void onsuccess domstring[] names, path path ; }; };

filesystem api the filesystem api provides access to a device's filesystem the filesystem is represented as an abstract collection of disjointed filesystem virtual root locations, each corresponding to a specific location in the device filesystem the filesystem api exposes the hierarchies below these root locations as autonomous virtual filesystems each virtual root has a string name each file or directory within the virtual filesystem is addressed using a fully-qualified path of the form <root name>/<path> where <rootname> is the name of the virtual root and <path> is the path to the file or directory relative to that root the following virtual roots must be supported images - the location for images videos - the location for videos music - the location for sounds documents - the location for documents downloads - the location for downloaded items camera - the location for the pictures and videos taken by a device supported since tizen 2 3 wgt-package - the location for widget package which is read-only wgt-private - the location for a widget's private storage wgt-private-tmp - the location for a widget's private volatile storage removable_ - the location for external storages the " " suffix is a unique identifier of an external storage to obtain list of available external storages use liststorages the file uri path is also supported to access paths out of virtual root, for example "file ///tmp" can be used as location parameter the implementation must support the use of the following characters in file names letters a-z, a-z digits 0-9 blank space underscore "_" hyphen "-" period " " the implementation may support additional characters in file names, depending on platform support the implementation may forbid the use of additional characters in file names, depending on the platform the use of the path component separator "/" and null character "x00" should not be allowed in file names some other file name and path characteristics are platform-dependent, for example, maximum path length, file name length, case sensitivity, additional character support, etc therefore, it is recommended to avoid any dependency on aspects that cannot be supported across multiple platforms the encoding used for the file path should be utf-16 default for ecmascript string remark in order to access files, a proper privilege has to be defined additionally for accessing only internal storage using this api, a privilege http //tizen org/privilege/mediastorage must be provided, for accessing only external storage using this api, a privilege http //tizen org/privilege/externalstorage must be provided, for accessing internal and external storage using this api, privileges http //tizen org/privilege/mediastorage and http //tizen org/privilege/externalstorage must be provided remark methods, which names end with nonblocking are asynchronous and are executed in background in the order in which they were called corresponding methods without nonblocking at the end are synchronous and will block further instructions execution, until they are finished for more information on the filesystem features, see file system guide since 1 0 summary of interfaces and methods interface method filesystemmanagerobject filesystemmanager filehandle openfile path path, filemode openmode, optional boolean makeparents void createdirectory path path, optional boolean makeparents, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void deletefile path path, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void deletedirectory path path, optional boolean recursive, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void copyfile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void copydirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void movefile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void movedirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void rename path path, domstring newname, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback void listdirectory path path, listdirectorysuccesscallback successcallback, optional errorcallback? errorcallback, optional filefilter? filter domstring touri path path boolean isfile path path boolean isdirectory path path boolean pathexists path path domstring getdirname domstring path void getstorage domstring label, filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror void liststorages filesystemstoragearraysuccesscallback onsuccess, optional errorcallback? onerror long addstoragestatechangelistener filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror void removestoragestatechangelistener long watchid filesystemstorage filehandle long long seek long long offset, optional baseseekposition whence void seeknonblocking long long offset, optional seeksuccesscallback? onsuccess, optional errorcallback? onerror, optional baseseekposition whence domstring readstring optional long long? count, optional domstring inputencoding void readstringnonblocking optional readstringsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long count, optional domstring inputencoding long long writestring domstring inputstring, optional domstring outputencoding void writestringnonblocking domstring inputstring, optional writestringsuccesscallback? onsuccess, optional errorcallback? onerror, optional domstring outputencoding blob readblob optional long long size void readblobnonblocking optional readblobsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size void writeblob blob blob void writeblobnonblocking blob blob, optional successcallback? onsuccess, optional errorcallback? onerror uint8array readdata optional long long size void readdatanonblocking optional readdatasuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size void writedata uint8array data void writedatanonblocking uint8array data, optional successcallback? onsuccess, optional errorcallback? onerror void flush void flushnonblocking optional successcallback? onsuccess, optional errorcallback? onerror void sync void syncnonblocking optional successcallback? onsuccess, optional errorcallback? onerror void close void closenonblocking optional successcallback? onsuccess, optional errorcallback? onerror filefilter filesystemstoragearraysuccesscallback void onsuccess filesystemstorage[] storages filesystemstoragesuccesscallback void onsuccess filesystemstorage storage pathsuccesscallback void onsuccess path path seeksuccesscallback void onsuccess long long position readstringsuccesscallback void onsuccess domstring string writestringsuccesscallback void onsuccess long long bytescount readblobsuccesscallback void onsuccess blob blob readdatasuccesscallback void onsuccess uint8array data listdirectorysuccesscallback void onsuccess domstring[] names, path path 1 type definitions 1 1 path string, which points to file or directory typedef domstring path; since 5 0 in methods available since tizen 5 0, checking or accessing files or directories may be granted only through a valid path paths may contain one of the supported virtual roots the valid path pattern is explained on the top of the page 1 2 filemode specifies the file mode when it is opened enum filemode { "a", "r", "rw", "rwo", "w" }; since 1 0 the file modes defined by this enumerator are a - append access r - read-only access rw - read and write access rwo - read and write access original file content are deleted w - write access remark rwo mode is supported since tizen 5 0 it will not be recognized by deprecated functions 1 3 filesystemstoragetype specifies the type of storage enum filesystemstoragetype { "internal", "external" }; since 1 0 internal - internal storage is a storage that cannot be removed, such as a flash memory external - external storage is removable storage, such as a usb drive or a memory card 1 4 filesystemstoragestate specifies the state of the storage enum filesystemstoragestate { "mounted", "removed", "unmountable" }; since 1 0 mounted - the device is mounted and can be browsed removed - the device has been removed this states applies only to external drives unmountable - the device cannot be mounted due to an error 1 5 blob this is a blob object defined in w3c file api see the blob interface typedef blob blob; since 5 0 1 6 baseseekposition specifies starting point for seek operation enum baseseekposition { "begin", "current", "end" }; since 5 0 begin - beginning of the file current - current position of file indicator end - end of the file 2 interfaces 2 1 filesystemmanagerobject the filesystemmanagerobject interface defines what is instantiated by the tizen object [nointerfaceobject] interface filesystemmanagerobject { readonly attribute filesystemmanager filesystem; }; tizen implements filesystemmanagerobject; since 1 0 there is a tizen filesystem object that allows accessing the functionality of the filesystem api attributes readonly filesystemmanager filesystem object representing a filesystem since 1 0 2 2 filesystemmanager the filesystemmanager interface provides access to the filesystem api [nointerfaceobject] interface filesystemmanager { readonly attribute long maxnamelength; readonly attribute long maxpathlength; filehandle openfile path path, filemode openmode, optional boolean makeparents raises webapiexception ; void createdirectory path path, optional boolean makeparents, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void deletefile path path, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void deletedirectory path path, optional boolean recursive, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void copyfile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void copydirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void movefile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void movedirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void rename path path, domstring newname, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void listdirectory path path, listdirectorysuccesscallback successcallback, optional errorcallback? errorcallback, optional filefilter? filter raises webapiexception ; domstring touri path path raises webapiexception ; boolean isfile path path raises webapiexception ; boolean isdirectory path path raises webapiexception ; boolean pathexists path path raises webapiexception ; domstring getdirname domstring path ; void resolve domstring location, filesuccesscallback onsuccess, optional errorcallback? onerror, optional filemode? mode raises webapiexception ; void getstorage domstring label, filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; void liststorages filesystemstoragearraysuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; long addstoragestatechangelistener filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; void removestoragestatechangelistener long watchid raises webapiexception ; }; since 1 0 this manager interface exposes the filesystem base api and provides functionalities, such as determining root and default locations, resolving a given location into a file handle and registering filesystem listeners for filesystem events attributes readonly long maxnamelength the maximum file or directory name length for the current platform since 5 0 code example console log "the maximum name length is " + tizen filesystem maxnamelength ; output example the maximum name length is 255 readonly long maxpathlength the maximum path length limit for the current platform since 1 0 code example console log "the maximum path length is " + tizen filesystem maxpathlength ; output example the maximum path length is 4096 methods openfile opens a file or creates a file pointed by path filehandle openfile path path, filemode openmode, optional boolean makeparents ; since 5 0 if the operation succeeds, a file handle to the newly created or opened file is returned, otherwise an exception is thrown following file open modes are supported a - append mode file position indicator is always set to the first position after the last character of the file and cannot be modified with seek operations write operations always append content to the end of the file original file content are not modified read operations cannot be performed if the file does not exist, it is created r - read mode file position indicator is initially set to the beginning of the file and may be changed with seek operations write operations cannot be performed original file content may be read in this mode if the file does not exist, notfounderror is thrown rw - read and write mode file position indicator is initially set to the beginning of the file and may be changed with seek operations original file content may be read or modified in this mode if the file does not exist, notfounderror will be thrown rwo - read and write mode, overwriting existing file content file position indicator is initially set to the beginning of the file read and write operations may be performed original file content are deleted before opening the file if the file does not exist, it is created w - write mode file position indicator is initially set to the beginning of the file and may be changed with seek operations read operations cannot be performed original file content are deleted before opening the file if the file does not exist, it is created privilege level public privilege http //tizen org/privilege/filesystem read privilege http //tizen org/privilege/filesystem write remark write permission is needed, when file is opened in modes a, rw, rwo and w read permission is needed, when file is opened in modes r, rw and rwo parameters path path to the file openmode mode in which the file is to be opened makeparents [optional] flag indicating whether lacking directories should be created for instance, if method is invoked with parameter path equal to documents/path/to/dir/file ext and there is no directory "path" in "documents" virtual root, directories "path", "to" and "dir" will be created, as well as the new file "file ext" by default, makeparents is equal to true its value is ignored, when openmode is r or rw return value filehandle object representing open file exceptions webapiexception with error type ioerror, if a file is not available for open or any other io error occurs with error type notfounderror, if the path does not point to an existing file with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; console log "file opened for writing" ; filehandlewrite writestring "lorem ipsum dolor sit amet " ; console log "string has been written to the file" ; filehandlewrite close ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; console log "file opened for reading" ; var filecontent = filehandleread readstring ; console log "file content " + filecontent ; filehandleread close ; output example file opened for writing string has been written to the file file opened for reading file content lorem ipsum dolor sit amet createdirectory creates directory pointed by path void createdirectory path path, optional boolean makeparents, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful directory creation invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if any of the input/output error occurs notfounderror, if directory given in path does not exist and makeparents is set to false privilege level public privilege http //tizen org/privilege/filesystem write parameters path path to directory to create makeparents [optional] flag indicating whether lacking directories should be created for instance, if method is invoked with parameter path equal to documents/path/to/dir and there is no directory "path" in "documents" virtual root, directories "path", "to" and "dir" will be created by default, makeparents is equal to true successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during directory creation " + error message ; } function successcallback path { console log "the directory has been created, path to created directory " + path ; /* directory can now be accessed */ } try { tizen filesystem createdirectory "documents/foo_dir/bar_dir", true, successcallback, errorcallback ; } catch error { console log "directory cannot be created " + error message ; } output example the directory has been created, path to created directory documents/foo_dir/bar_dir deletefile deletes file pointed by path void deletefile path path, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful file deletion invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if any of the input/output error occurs notfounderror, if the path does not point to an existing file privilege level public privilege http //tizen org/privilege/filesystem write parameters path path to file successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during file deletion " + error message ; } function successcallback path { console log "the file has been deleted, path to the parent of deleted file " + path ; } try { tizen filesystem deletefile "documents/foo", successcallback, errorcallback ; } catch error { console log "file cannot be deleted " + error message ; } output example the file has been deleted, path to the parent of deleted file documents deletedirectory deletes directory or directory tree under the current directory pointed by path void deletedirectory path path, optional boolean recursive, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful directory deletion invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if a directory is not empty and recursive is equal to false notfounderror, if the path does not point to an existing directory privilege level public privilege http //tizen org/privilege/filesystem write parameters path a path to directory recursive [optional] flag indicating whether the deletion is recursive or not if recursive is set to true the method will delete content of a given directory recursively otherwise, the method succeeds only if the directory is empty, on other cases errorcallback is called by default, recursive is equal to true successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during directory deletion " + error message ; } function successcallback path { console log "the directory has been deleted, path to the parent of deleted directory " + path ; } try { tizen filesystem deletedirectory "documents/foo_dir", true, successcallback, errorcallback ; } catch error { console log "directory cannot be deleted " + error message ; } output example the directory has been deleted, path to the parent of deleted directory documents copyfile copies file from location pointed by sourcepath to destinationpath void copyfile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful file copying invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if any of the input/output error occurs notfounderror, if the sourcepath does not point to an existing file privilege level public privilege http //tizen org/privilege/filesystem read privilege http //tizen org/privilege/filesystem write parameters sourcepath path to file destinationpath path for copied file the path must consist of path to an existing directory concatenated with '/' and the name of new file overwrite [optional] flag indicating whether to overwrite an existing file if overwrite is set to true and file pointed by destinationpath already exists, the method will overwrite the file otherwise, if a file with conflicting name already exists errorcallback is called by default, overwrite is equal to false successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if any of the input parameters contains an invalid value for example, the sourcepath or the destinationpath is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during copy operation " + error message ; } function successcallback path { console log "the file has been copied, path to copied file " + path ; /* file copy can now be accessed */ } try { tizen filesystem copyfile "documents/foo", "documents/bar", true, successcallback, errorcallback ; } catch error { console log "copy operation cannot be performed " + error message ; } output example the file has been copied, path to copied file documents/bar copydirectory recursively copies directory pointed by sourcepath to destinationpath void copydirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 the method merges content of the directory pointed by sourcepath with content of the directory pointed by destinationpath, if exists if the directory pointed by destinationpath does not exist, it is created successful directory copying invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if a directory with conflicting name already exists and overwrite is equal to false or any of the input/output error occurs notfounderror, if the sourcepath does not point to an existing directory privilege level public privilege http //tizen org/privilege/filesystem read privilege http //tizen org/privilege/filesystem write parameters sourcepath path to directory destinationpath path for copied directory the path must consist of path to an existing directory concatenated with '/' and the name of destination directory overwrite [optional] flag indicating whether to overwrite existing content if overwrite is equal to true, the file or directory with conflicting name will be overwritten otherwise, errorcallback will be called with ioerror by default, overwrite is equal to false successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if any of the input parameters contains an invalid value for example, the sourcepath or the destinationpath is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during copy operation " + error message ; } function successcallback path { console log "the directory has been copied, path to copied directory " + path ; /* directory copy can now be accessed */ } try { tizen filesystem copydirectory "documents/foo_dir", "documents/bar_dir", true, successcallback, errorcallback ; } catch error { console log "copy operation cannot be performed " + error message ; } output example the directory has been copied, path to copied directory documents/bar_dir code example function errorcallback error { console log "an error occurred " + error message ; } function createfoodircallback { tizen filesystem createdirectory "documents/foo_dir/dir_2", true, createfilecallback, errorcallback ; } function listcallback files, path { console log "found inside " + path + " directory " ; for var i = 0; i < files length; i++ { console log files[i] ; } } function successcallback path { console log "the directory has been created and copied, path to directory " + path ; /* directory 'documents/bar_dir' content is as below */ /* documents/bar_dir/dir_1 */ /* documents/bar_dir/dir_2 */ /* documents/bar_dir/dir_1/file */ tizen filesystem listdirectory "documents/bar_dir", listcallback, errorcallback ; tizen filesystem listdirectory "documents/bar_dir/dir_1", listcallback, errorcallback ; } function createfilecallback { tizen filesystem openfile "documents/foo_dir/dir_1/file", "w" close ; try { tizen filesystem copydirectory "documents/foo_dir", "documents/bar_dir", true, successcallback, errorcallback ; } catch error { console log "copy operation cannot be performed " + error message ; } } tizen filesystem createdirectory "documents/foo_dir/dir_1", true, createfoodircallback, errorcallback ; output example the directory has been created and copied, path to directory documents/bar_dir found inside documents/bar_dir directory dir_1 dir_2 found inside documents/bar_dir/dir_1 directory file movefile moves file pointed by sourcepath to destinationpath void movefile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful file moving invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if a file with conflicting name already exists and overwrite is equal to false or any of the input/output error occurs notfounderror, if the sourcepath or destinationpath does not point to an existing file or directory privilege level public privilege http //tizen org/privilege/filesystem read privilege http //tizen org/privilege/filesystem write parameters sourcepath path to file destinationpath a destination directory path to move the file to overwrite [optional] flag indicating whether to overwrite an existing file if overwrite is set to true and file with the same name in destinationpath already exists, the method will overwrite the file otherwise, if a file with conflicting name already exists errorcallback is called by default, overwrite is equal to false successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if any of the input parameters contains an invalid value for example, the sourcepath or the destinationpath is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during move operation " + error message ; } function successcallback path { console log "the file has been moved, path to moved file " + path ; /* moved file can now be accessed */ } try { tizen filesystem movefile "documents/foo", "documents/foo_dir/", false, successcallback, errorcallback ; } catch error { console log "move operation cannot be performed " + error message ; } output example the file has been moved, path to moved file documents/foo_dir/foo movedirectory recursively moves directory pointed by sourcepath to destinationpath void movedirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 the method merges content of the directory pointed by sourcepath with content of the directory with the same name in destinationpath, if exists successful directory moving invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if a directory with conflicting name already exists and overwrite is equal to false or any of the input/output error occurs notfounderror, if the sourcepath or destinationpath does not point to an existing directory privilege level public privilege http //tizen org/privilege/filesystem read privilege http //tizen org/privilege/filesystem write parameters sourcepath a path to directory destinationpath a destination directory path to move the directory to overwrite [optional] flag indicating whether to overwrite existing content if overwrite is equal to true, the file or directory with conflicting name will be overwritten otherwise, errorcallback will be called with ioerror by default, overwrite is equal to false successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if any of the input parameters contains an invalid value for example, the sourcepath or the destinationpath is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during move operation " + error message ; } function successcallback path { console log "the directory has been moved, path to moved directory " + path ; /* moved directory can now be accessed */ } try { tizen filesystem movedirectory "documents/foo_dir", "documents/bar_dir/", false, successcallback, errorcallback ; } catch error { console log "move operation cannot be performed " + error message ; } output example the directory has been moved, path to moved directory documents/bar_dir/foo_dir rename renames file or directory located in path to name newname void rename path path, domstring newname, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback ; since 5 0 successful renaming invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified the errorcallback is launched with these error types ioerror, if a file or a directory with conflicting name already exists or any of the input/output error occurs notfounderror, if the path does not point to an existing file or directory privilege level public privilege http //tizen org/privilege/filesystem write parameters path a path to directory or file newname a new name of directory or file successcallback [optional] [nullable] callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type invalidvalueserror, if the path or newname is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during rename operation " + error message ; } function successcallback path { console log "the file has been renamed, path to renamed file or directory " + path ; } try { tizen filesystem rename "documents/foo", "bar", successcallback, errorcallback ; } catch error { console log "rename operation cannot be performed " + error message ; } output example the file has been renamed, path to renamed file or directory documents/bar listdirectory lists directory content located in path void listdirectory path path, listdirectorysuccesscallback successcallback, optional errorcallback? errorcallback, optional filefilter? filter ; since 5 0 successful listing of directory content invokes successcallback function, if specified in case of failure errorcallback function is invoked, if specified if the filter is passed and contains valid values, only those directories or files in the directory that match the filter criteria specified in the filefilter interface are returned in successcallback method if the filter is null or undefined the implementation must return the full list of files in the directory if the directory does not contain any files or directories, or the filter criteria do not match with any files or directories, the successcallback is invoked with an empty array the errorcallback is launched with these error types ioerror, if any of the input/output error occurs notfounderror, if the path does not point to an existing directory privilege level public privilege http //tizen org/privilege/filesystem read parameters path a path to directory successcallback callback function to be invoked on success errorcallback [optional] [nullable] callback function to be invoked when an error occurs filter [optional] [nullable] filter to restrict the listed files exceptions webapiexception with error type invalidvalueserror, if any of the input parameters contains an invalid value for example, the path is invalid with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example function errorcallback error { console log "an error occurred, during directory listing " + error message ; } function successcallback files, path { console log "found directories in " + path + " directory " ; for var i = 0; i < files length; i++ { console log files[i] ; } } try { var start = new date "jan 01 2018 00 00 00" ; tizen filesystem listdirectory "documents/", successcallback, errorcallback, {name "foo_%", isdirectory true, startmodified start} ; } catch error { console log "directory listing cannot be performed " + error message ; } output example found directories in documents/ directory foo_dir_c foo_dir_b foo_dir_d foo_dir_a touri converts path to file uri domstring touri path path ; since 5 0 remark the function does not check if path exists in filesystem parameters path a path to a file or a directory return value domstring file uri for given path exceptions webapiexception with error type invalidvalueserror, if the path is invalid code example var path1 = tizen filesystem touri "documents/directory/file ext" ; var path2 = tizen filesystem touri "/opt/usr/home/owner/content/documents/directory/file ext" ; var path3 = tizen filesystem touri "file ///opt/usr/home/owner/content/documents/directory/file ext" ; /* all above paths point to the same file */ console log path1 ; console log path2 ; console log path3 ; var mmcpath = tizen filesystem touri "removable_sda1/documents/directory/file" ; console log mmcpath ; output example file ///opt/usr/home/owner/content/documents/directory/file ext file ///opt/usr/home/owner/content/documents/directory/file ext file ///opt/usr/home/owner/content/documents/directory/file ext file ///opt/media/usbdrivea1/documents/directory/file isfile checks if given path points to a file boolean isfile path path ; since 5 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters path a path to be tested return value boolean true if path points to a file, false otherwise exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type ioerror, if any of the input/output error occurs with error type notfounderror, if the path does not point to an existing file or directory with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example console log "documents/foo_file is " + tizen filesystem isfile "documents/foo_file" ? "file" "directory" ; output example documents/foo_file is file isdirectory checks if given path points to a directory boolean isdirectory path path ; since 5 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters path a path to be tested return value boolean true if path points to a directory, false otherwise exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type ioerror, if any of the input/output error occurs with error type notfounderror, if the path does not point to an existing file or directory with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example console log "documents/foo_dir is " + tizen filesystem isdirectory "documents/foo_dir" ? "directory" "file" ; output example documents/foo_dir is directory pathexists checks if given path exists boolean pathexists path path ; since 5 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters path a path to be tested return value boolean true if path points to a existing element, false otherwise exceptions webapiexception with error type invalidvalueserror, if the path is invalid with error type ioerror, if input/output error occurs with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example console log "documents/foo " + tizen filesystem pathexists "documents/foo" ? "exists" "does not exist" ; output example documents/foo does not exist getdirname returns path to directory for given path domstring getdirname domstring path ; since 5 0 strips trailing '/', then breaks path into two components by last path separator, returns first component remark this function does not check if path is valid or exists in filesystem parameters path path to file or directory return value domstring path to directory for given path code example console log tizen filesystem getdirname "/home/owner/media/documents" ; output example "/home/owner/media" resolve resolves a location to a file handle after validating it deprecated since 5 0 void resolve domstring location, filesuccesscallback onsuccess, optional errorcallback? onerror, optional filemode? mode ; since 1 0 a location can contain a virtual path like "documents/some_file txt" or a file uri like "file ///my_strange_path/some_file png" a location is not allowed to contain the " " or " " directory entries inside its value the list of root locations that must be supported by a compliant implementation are documents - the default folder in which text documents such as pdf, doc are stored by default in a device for example, in some platforms it corresponds to the "my documents" folder images - the default folder in which still images, like pictures in formats including jpg, gif, png, etc , are stored in the device by default for example, in some platforms it corresponds to the "my images" folder music - the default folder in which sound clips in formats including mp3, aac, etc are stored in the device by default for example, in some platforms it corresponds to the "my music" folder videos - the default folder in which video clips in formats including avi, mp4, etc are stored in the device by default for example, in some platforms it corresponds to the "my videos" folder downloads - the default folder in which downloaded files from sources including browser, e-mail client, etc are stored by default in the device for example, in some platforms it corresponds to the "downloads" folder ringtones - the default folder in which ringtones such as mp3, etc are stored in the device camera - the default folder in which pictures and videos taken by a device are stored wgt-package - the read-only folder to which the content of a widget file is extracted wgt-private - the private folder in which a widget stores its information this folder must be accessible only to the same widget and other widgets or applications must not be able to access the stored information wgt-private-tmp - temporary, the private folder in which a widget can store data that is available during a widget execution cycle content of this folder can be removed from this directory when the widget is closed or the web runtime is restarted this folder must be accessible only to the same widget and other widgets or applications must not be able to access it the mode parameter specifies whether the resulting file object has read-only access r access , read and write access rw access , append access a access , or write access w access to the root location containing directory tree permission for the requested access is obtained from the security framework once the resulting file object has access, access is inherited by any other file objects that are derived from this instance without any further reference to the security framework, as noted in descriptions of certain methods of file the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value for example, the mode is w for the read-only virtual roots wgt-package and ringtones notfounderror - if the location input argument does not correspond to a valid location unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read remark camera location is supported since tizen 2 3 if a device does not support camera, notsupportederror will be thrown parameters location location to resolve that can be a virtual path or file uri onsuccess callback method to be invoked when the location has been successfully resolved, passing the newly created file object onerror [optional] [nullable] callback method to be invoked when an error has occurred mode [optional] [nullable] optional value to indicate the file access mode on all files and directories that can be reached from the file object passed to onsuccess default value of this parameter is rw if absent or null exceptions webapiexception with error type notsupportederror, if this feature is not supported e g in the case of "camera" virtual path if the device does not support camera , or if mode has been set to "rwo", which was introduced in tizen version 5 0 with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type typemismatcherror, if any of the input parameters is not compatible with the expected type for that parameter code example tizen filesystem resolve "images", function dir { console log "images are stored in " + dir path ; }, function e { console log "error " + e message ; }, "r" ; getstorage gets information about a storage based on its label for example "mythumbdrive", "internalflash" void getstorage domstring label, filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror ; since 1 0 the onsuccess method receives the data structure as an input argument containing additional information about the drive the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value notfounderror - if no drive was found with the given label unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read parameters label storage label onsuccess callback method to be invoked when the list of storages is available, passing the storage list to the callback onerror [optional] [nullable] callback method to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example function onstorage storage { /* do something */ } function onstorageerror e { console log "storage not found " + e message ; } tizen filesystem getstorage "music", onstorage, onstorageerror ; liststorages lists the available storages both internal and external on a device the onsuccess method receives a list of the data structures as input argument containing additional information about each drive found it can get storages that would have a label named as "internal0", virtual roots images, documents, , "removable1", "removable2" "removable1" label is used to resolve sdcard and "removable2" label is used to resolve usb host, if supported the vfat filesystem used to sdcard filesystem widely is not case-sensitive if you want to handle the file on sdcard, you need to consider case-sensitive filenames are regarded as same name void liststorages filesystemstoragearraysuccesscallback onsuccess, optional errorcallback? onerror ; since 1 0 labels can differ depending on platform implementation the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read parameters onsuccess callback method to be invoked when a list of storage is available and passing the storage list to the callback onerror [optional] [nullable] callback method to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example function alertforcorruptedremovabledrives storages { for var i = 0; i < storages length; i++ { if storages[i] type != "external" continue; if storages[i] state == "unmountable" console log "external drive " + storages[i] label + " is corrupted " ; } } tizen filesystem liststorages alertforcorruptedremovabledrives ; addstoragestatechangelistener adds a listener to subscribe to notifications when a change in storage state occurs long addstoragestatechangelistener filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror ; since 1 0 the most common usage for this method is to watch for any additions and removals of external storages when executed, it returns a subscription identifier that identifies the watch operation after returning the identifier, the watch operation is started asynchronously the onsuccess method will be invoked every time a storage state changes if the attempt fails, the onerror if present will be invoked with the relevant error type the watch operation must continue until the removestoragestatechangelistener method is called with the corresponding subscription identifier privilege level public privilege http //tizen org/privilege/filesystem write parameters onsuccess callback method to be invoked when any change is made to storage state onerror [optional] [nullable] callback method to be invoked when an error occurs during the watch process return value long subscription identifier exceptions webapiexception with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges with error type typemismatcherror, if any input parameter is not compatible with the expected type for that parameter with error type unknownerror, if any other error occurs code example var watchid; function onstoragestatechanged storage { if storage state == "mounted" console log "storage " + storage label + " was added!" ; } watchid = tizen filesystem addstoragestatechangelistener onstoragestatechanged ; removestoragestatechangelistener removes a listener to unsubscribe from a storage watch operation void removestoragestatechangelistener long watchid ; since 1 0 if the watchid argument is valid and corresponds to a subscription already in place, the watch process will be stopped and no further callbacks will be invoked otherwise, the method call has no effect privilege level public privilege http //tizen org/privilege/filesystem write parameters watchid subscription identifier exceptions webapiexception with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges with error type unknownerror, if any other error occurs code example var watchid; function onstoragestatechanged storage { if storage state == "mounted" console log "storage " + storage label + " was added!" ; tizen filesystem removestoragestatechangelistener watchid ; } watchid = tizen filesystem addstoragestatechangelistener onstoragestatechanged ; 2 3 filesystemstorage the filesystemstorage interface gives additional information about a storage, such as if the device is mounted, if it is a removable drive or not, or the device's name [nointerfaceobject] interface filesystemstorage { readonly attribute domstring label; readonly attribute filesystemstoragetype type; readonly attribute filesystemstoragestate state; }; since 1 0 to retrieve the mount point, the resolve method should be used using the label as argument attributes readonly domstring label the storage name this attribute is used as an input for methods such as getstorage and also used as location parameter for file resolve and filesystemmanager resolve since 1 0 readonly filesystemstoragetype type the storage type as internal or external since 1 0 readonly filesystemstoragestate state the storage state as mounted or not since 1 0 2 4 filehandle object representing file, used for read/write operations [nointerfaceobject] interface filehandle { readonly attribute path path; long long seek long long offset, optional baseseekposition whence raises webapiexception ; void seeknonblocking long long offset, optional seeksuccesscallback? onsuccess, optional errorcallback? onerror, optional baseseekposition whence raises webapiexception ; domstring readstring optional long long? count, optional domstring inputencoding raises webapiexception ; void readstringnonblocking optional readstringsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long count, optional domstring inputencoding raises webapiexception ; long long writestring domstring inputstring, optional domstring outputencoding raises webapiexception ; void writestringnonblocking domstring inputstring, optional writestringsuccesscallback? onsuccess, optional errorcallback? onerror, optional domstring outputencoding raises webapiexception ; blob readblob optional long long size raises webapiexception ; void readblobnonblocking optional readblobsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size raises webapiexception ; void writeblob blob blob raises webapiexception ; void writeblobnonblocking blob blob, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; uint8array readdata optional long long size raises webapiexception ; void readdatanonblocking optional readdatasuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size raises webapiexception ; void writedata uint8array data raises webapiexception ; void writedatanonblocking uint8array data, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void flush raises webapiexception ; void flushnonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void sync raises webapiexception ; void syncnonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void close raises webapiexception ; void closenonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; }; since 5 0 each read or write operation moves position in file forwards to the end of read/written data there is an underlying file position's indicator remark due to multibyte utf-8 encoding, if current file's pointer does not point to beginning of multibyte sequence see utf-16, emoji , using seek combined with utf-8 readstring will result in string starting from valid character incomplete byte sequence at the beginning may be omitted be aware about using seek and write methods together it can result in writing in the middle of multibyte sequence, which can lead to file with corrupted content attributes readonly path path path, as passed to openfile since 5 0 methods seek sets position indicator in file stream to offset long long seek long long offset, optional baseseekposition whence ; since 5 0 note, that current position indicator value, can be obtained by calling seek 0, "current" parameters offset number of bytes to shift the position relative to whence whence [optional] determines position in file stream to which offset is added default value "begin" return value long long file position indicator exceptions webapiexception with error type ioerror, if seek fails or any error related to file handle occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example var datatowrite = new uint8array [11, 21, 31, 44, 55, 66, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedata datatowrite ; filehandlewrite close ; console log "data has been written" ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var firstthreebytes = filehandleread readdata 3 ; console log "first three bytes " + firstthreebytes ; var position = filehandleread seek -3, "end" ; /* moving to position three bytes to the end of file */ var lastthreebytes = filehandleread readdata 3 ; console log "last three bytes " + lastthreebytes ; filehandleread seek 3, "begin" ; /* moving to position at third byte */ var bytesbetween = filehandleread readdata position - 3 ; console log "bytes between " + bytesbetween ; filehandleread close ; output example data has been written first three bytes 11,21,31 last three bytes 71,81,91 bytes between 44,55,66 seeknonblocking sets position indicator in file stream to offset void seeknonblocking long long offset, optional seeksuccesscallback? onsuccess, optional errorcallback? onerror, optional baseseekposition whence ; since 5 0 successful seek operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if any error related to file handle occurs note, that current position indicator value, can be obtained in seeksuccesscallback by calling seeknonblocking 0, "current" seeknonblocking is executed in background and does not block further instructions parameters offset number of bytes to shift the position relative to whence onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs whence [optional] determines position in file stream to which offset is added default value "begin" exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writestringnonblocking "lorem ipsum dolor sit amet ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; /* moving to position 3 bytes to the end of file to alter three dots " " */ filehandlewrite seeknonblocking -3, function new_position { console log "moved to position " + new_position ; }, function error { console log error ; }, "end" ; filehandlewrite writestringnonblocking ", consectetur adipiscing elit ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; /* moving to position 3 bytes to the end of file to alter three dots " " */ filehandlewrite seeknonblocking -3, function new_position { console log "moved to position " + new_position ; }, function error { console log error ; }, "end" ; filehandlewrite writestringnonblocking ", sed do eiusmod ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; /* readstringsuccesscallback should be executed */ filehandleread readstringnonblocking function output { console log "file content " + output ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example number of bytes written 29 moved to position 26 number of bytes written 32 moved to position 55 number of bytes written 19 file handle closed file content lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod file handle closed readstring reads file content as string domstring readstring optional long long? count, optional domstring inputencoding ; since 5 0 sets file handle position indicator at the end of read data reads given number of characters remark resulting string can have length larger than count, due to possible utf-16 surrogate pairs in it string length in javascript is counted in utf-16 encoding, so for example string containing one emoji surrogate of two utf-16 character will have length of two parameters count [optional] [nullable] number of characters to read from file if none is given, method attempts to read whole file inputencoding [optional] default value "utf-8" encoding to use for read operation on the file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin-1 encoding return value domstring string with data read from file exceptions webapiexception with error type invalidvalueserror if given count exceeds maximum value supported by the device with error type ioerror, if read fails or any error related to file handle occurs with error type notsupportederror, if the given encoding is not supported with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; console log "file opened for writing" ; filehandlewrite writestring "lorem ipsum dolor sit amet " ; console log "string has been written to the file" ; filehandlewrite close ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; console log "file opened for reading" ; var filecontent = filehandleread readstring ; console log "file content " + filecontent ; filehandleread close ; output example file opened for writing string has been written to the file file opened for reading file content lorem ipsum dolor sit amet readstringnonblocking reads file content as string void readstringnonblocking optional readstringsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long count, optional domstring inputencoding ; since 5 0 reads given number of characters sets file handle position indicator at the end of read data readstringnonblocking is executed in background and does not block further instructions successful read operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if read fails or any error related to file handle occurs parameters onsuccess [optional] [nullable] callback function with read data from file to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs count [optional] number of characters to read from file if none is given, method attempts to read whole file inputencoding [optional] default value "utf-8" encoding to use for read operation on the file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin-1 encoding exceptions webapiexception with error type invalidvalueserror if given count exceeds maximum value supported by the device with error type notsupportederror, if the given encoding is not supported with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; console log "file opened for writing" ; filehandlewrite writestringnonblocking "lorem ipsum dolor sit amet ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; /* readstringsuccesscallback should be executed */ filehandleread readstringnonblocking function output { console log "file content " + output ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example file opened for writing number of bytes written 29 file handle closed file content lorem ipsum dolor sit amet file handle closed writestring writes inputstring content to a file long long writestring domstring inputstring, optional domstring outputencoding ; since 5 0 sets file handle position indicator at the end of written data parameters inputstring string value to be written to a file outputencoding [optional] default value utf-8 encoding to use for write operation on the file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin-1 encoding return value long long number of bytes written can be more than inputstring length for multibyte encodings and will never be less exceptions webapiexception with error type ioerror, if input/output error occurs with error type notsupportederror, if the given encoding is not supported code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; console log "file opened for writing" ; filehandlewrite writestring "lorem ipsum dolor sit amet " ; console log "string has been written to the file" ; filehandlewrite close ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; console log "file opened for reading" ; var filecontent = filehandleread readstring ; console log "file content " + filecontent ; filehandleread close ; output example file opened for writing string has been written to the file file opened for reading file content lorem ipsum dolor sit amet writestringnonblocking writes inputstring content to a file void writestringnonblocking domstring inputstring, optional writestringsuccesscallback? onsuccess, optional errorcallback? onerror, optional domstring outputencoding ; since 5 0 sets file handle position indicator at the end of written data writestringnonblocking is executed in background and does not block further instructions successful write operation invokes successcallback function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if write fails or any error related to file handle occurs parameters inputstring string value to be written to a file onsuccess [optional] [nullable] callback function with a number of bytes written as parameter to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs outputencoding [optional] default value "utf-8" encoding to use for write operation on the file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin-1 encoding exceptions webapiexception with error type notsupportederror, if the given encoding is not supported with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writestringnonblocking "lorem ipsum dolor sit amet ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; /* readstringsuccesscallback should be executed */ filehandleread readstringnonblocking function output { console log "file content " + output ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example number of bytes written 29 file handle closed file content lorem ipsum dolor sit amet file handle closed readblob reads file content as blob blob readblob optional long long size ; since 5 0 sets file handle position indicator at the end of read data parameters size [optional] size in bytes of data to read from file if none is given, method attempts to read whole file return value blob blob object with file content exceptions webapiexception with error type invalidvalueserror if given size exceeds maximum value supported by the device with error type ioerror, if read fails or any error related to file handle occurs code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; var b = new blob ["lorem ipsum dolor sit amet "], {type "text/plain"} ; filehandlewrite writeblob b ; filehandlewrite close ; console log "blob content has been written to file" ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var filecontentinblob = filehandleread readblob ; filehandleread close ; const reader = new filereader ; /* event fires after the blob has been read/loaded */ reader onloadend = function content { const text = content srcelement result; console log "file content " + text ; }; /* starts reading the blob as text */ reader readastext filecontentinblob ; output example blob content has been written to file file content lorem ipsum dolor sit amet readblobnonblocking reads file content as blob void readblobnonblocking optional readblobsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size ; since 5 0 sets file handle position indicator at the end of read data readblobnonblocking is executed in background and does not block further instructions successful read operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if read fails or any error related to file handle occurs parameters onsuccess [optional] [nullable] callback function with blob object to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs size [optional] [nullable] size in bytes of data to read from file if none is given, method attempts to read whole file exceptions webapiexception with error type invalidvalueserror if given size exceeds maximum value supported by the device with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; var b = new blob ["lorem ipsum dolor sit amet "], {type "text/plain"} ; filehandlewrite writeblobnonblocking b, function { console log "blob content has been written to file" ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; /* creation of a reader capable of extracting blob content */ const reader = new filereader ; /* event fires after the blob has been read/loaded */ reader onloadend = function content { const text = content srcelement result; console log "file content " + text ; }; function readblobcallback filecontentinblob { reader readastext filecontentinblob ; } /* readblobcallback should be executed */ filehandleread readblobnonblocking readblobcallback, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example blob content has been written to file file handle closed file handle closed file content lorem ipsum dolor sit amet writeblob writes blob to file void writeblob blob blob ; since 5 0 sets file handle position indicator at the end of written data parameters blob object of type blob, which content will be written to a file exceptions webapiexception with error type ioerror, if write fails or any error related to file handle occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; var b = new blob ["lorem ipsum dolor sit amet "], {type "text/plain"} ; filehandlewrite writeblob b ; filehandlewrite close ; console log "blob content has been written to file" ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var filecontentinblob = filehandleread readblob ; filehandleread close ; console log "file content has been read from file" ; const reader = new filereader ; /* event fires after the blob has been read/loaded */ reader onloadend = function content { const text = content srcelement result; console log "file content " + text ; }; /* starts reading the blob as text */ reader readastext filecontentinblob ; output example blob content has been written to file file content has been read from file file content lorem ipsum dolor sit amet writeblobnonblocking writes blob to file void writeblobnonblocking blob blob, optional successcallback? onsuccess, optional errorcallback? onerror ; since 5 0 sets file handle position indicator at the end of written data writeblobnonblocking is executed in background and does not block further instructions successful write operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if write fails or any error related to file handle occurs parameters blob object of type blob, which content will be written to a file onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; var b = new blob ["lorem ipsum dolor sit amet "], {type "text/plain"} ; filehandlewrite writeblobnonblocking b, function { console log "blob content has been written to file" ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; /* creation of a reader capable of extracting blob content */ const reader = new filereader ; /* event fires after the blob has been read/loaded */ reader onloadend = function content { const text = content srcelement result; console log "file content " + text ; }; function readblobcallback filecontentinblob { reader readastext filecontentinblob ; } /* readblobcallback should be executed */ filehandleread readblobnonblocking readblobcallback ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example blob content has been written to file file handle closed file handle closed file content lorem ipsum dolor sit amet readdata reads file content as binary data uint8array readdata optional long long size ; since 5 0 can be used in combination with atob or btoa functions sets file handle position indicator at the end of read data parameters size [optional] size in bytes of data to read from file if none is given, method attempts to read whole file return value uint8array read data as uint8array exceptions webapiexception with error type invalidvalueserror if given size exceeds maximum value supported by the device with error type ioerror, if read fails or any error related to file handle occurs code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedata datatowrite ; filehandlewrite close ; console log "data has been written" ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var filecontentinuint8array = filehandleread readdata ; filehandleread close ; console log "data read from file " + filecontentinuint8array ; output example data has been written data read from file 11,21,31,71,81,91 readdatanonblocking reads file content as binary data void readdatanonblocking optional readdatasuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size ; since 5 0 can be used in combination with atob or btoa functions sets file handle position indicator at the end of read data readdatanonblocking is executed in background and does not block further instructions successful read operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if read fails or any error related to file handle occurs parameters onsuccess [optional] [nullable] callback function with read data from file to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs size [optional] [nullable] size in bytes of data to read from file if none is given, method attempts to read whole file exceptions webapiexception with error type invalidvalueserror if given size exceeds maximum value supported by the device with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedatanonblocking datatowrite, function dataread { console log "write done" ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; filehandleread readdatanonblocking function dataread { console log "data read from file " + dataread ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example write done file handle closed data read from file 11,21,31,71,81,91 file handle closed writedata writes binary data to file void writedata uint8array data ; since 5 0 can be used in combination with atob or btoa functions sets file handle position indicator at the end of written data parameters data an array of type uint8array, which content will be written to file as binary data exceptions webapiexception with error type ioerror, if write fails or any error related to file handle occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedata datatowrite ; filehandlewrite close ; console log "data has been written" ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var filecontentinuint8array = filehandleread readdata ; filehandleread close ; console log "data read from file " + filecontentinuint8array ; output example data has been written data read from file 11,21,31,71,81,91 writedatanonblocking writes binary data to file void writedatanonblocking uint8array data, optional successcallback? onsuccess, optional errorcallback? onerror ; since 5 0 can be used in combination with atob or btoa functions sets file handle position indicator at the end of written data writedatanonblocking is executed in background and does not block further instructions successful write operation invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if write fails or any error related to file handle occurs parameters data an array of type uint8array, which content will be written to file as binary data onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedatanonblocking datatowrite, function dataread { console log "write done" ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - below code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; filehandleread readdatanonblocking function dataread { console log "data read from file " + dataread ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example write done file handle closed data read from file 11,21,31,71,81,91 file handle closed flush flushes data void flush ; since 5 0 for file handles with permission to write, flush writes any changes made to file content to underlying buffer flush does not ensure that data is written on storage device, it only synchronizes ram with file descriptor to ensure storage synchronization use sync, close or their asynchronous equivalent methods, which guarantee such synchronization exceptions webapiexception with error type ioerror, if flush fails or any error related to file handle occurs code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; var filehandleread = tizen filesystem openfile "documents/file", "r" ; filehandlewrite writestring "lorem ipsum dolor sit amet " ; console log "data has been written to file" ; /* calling flush ensures that content has been written to file descriptor and can be read by any */ /* process */ filehandlewrite flush ; console log "data has been flushed to system file buffer and now can be read" ; var filecontent = filehandleread readstring ; console log "read data " + filecontent ; filehandlewrite close ; filehandleread close ; output example data has been written to file data has been flushed to system file buffer and now can be read read data lorem ipsum dolor sit amet flushnonblocking flushes data void flushnonblocking optional successcallback? onsuccess, optional errorcallback? onerror ; since 5 0 for file handles with permission to write, flush writes any changes made to file content to underlying buffer flush does not ensure that data is written on storage device, it only synchronizes ram with file descriptor to ensure storage synchronization use sync, close or their asynchronous equivalent methods, which guarantee such synchronization successful flushing invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if flush fails or any error related to file handle occurs this method is asynchronous its execution will occur in background and after all previously commissioned background jobs will finish parameters onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writestringnonblocking "lorem ipsum dolor sit amet ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; /* calling flushnonblocking ensures that content will be written to file descriptor */ /* and can be read by any process */ filehandlewrite flushnonblocking function { console log "data has been flushed to system file buffer and now can be read" ; }, function error { console log error ; } ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; filehandleread readstringnonblocking function output { console log "file content " + output ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example number of bytes written 29 data has been flushed to system file buffer and now can be read file content lorem ipsum dolor sit amet file handle closed file handle closed sync synchronizes data to storage device void sync ; since 5 0 the sync function is intended to force a physical write of data from the buffer cache and to assure that after a system crash or other failure that all data up to the time of the sync call is recorded on the disk exceptions webapiexception with error type ioerror, if sync fails or any error related to file handle occurs code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedata datatowrite ; /* calling sync forces a physical write of data, so it is safe */ /* even after system crash or power shut down */ filehandlewrite sync ; console log "data has been synced" ; /* close method provides the same functionality as sync and ends access to file */ filehandlewrite close ; output example data has been synced **syncnonblocking ** synchronizes data to storage device void syncnonblocking optional successcallback? onsuccess, optional errorcallback? onerror ; since 5 0 the syncnonblocking function is intended to force a physical write of data from the buffer cache and to assure that after a system crash or other failure that all data up to the time of the syncnonblocking execution is recorded on the disk successful syncing invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if sync fails or any error related to file handle occurs this method is asynchronous its execution will occur in background and after all previously commissioned background jobs will finish parameters onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example var datatowrite = new uint8array [11, 21, 31, 71, 81, 91] ; /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writedatanonblocking datatowrite, function dataread { console log "write done" ; }, function error { console log error ; } ; /* calling syncnonblocking will force a physical write of data, so it will be safe */ /* even after system crash or power shut down */ filehandlewrite syncnonblocking function { console log "data has been synced" ; }, function error { console log error ; } ; /* close method provides the same functionality as sync and ends access to file */ filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example write done data has been synced file handle closed close closes file handle void close ; since 5 0 closes the given file stream closing file guarantees writing changes made to filehandle to the storage device further operations on this file handle are not allowed remark this method is synchronous if any asynchronous method was called before close, close will block further instructions until all background jobs finish execution note, that if file handle functions are put into any callbacks and this callback was not yet called, synchronous close will wait only for already ordered background jobs to finish, preventing successful execution of any further operations on closed file handle exceptions webapiexception with error type ioerror, if close fails or any error related to file handle occurs code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writestring "lorem ipsum dolor sit amet " ; filehandlewrite close ; console log "string has been written to the file" ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var positionoffileend = filehandleread seek 0, "end" ; console log "seek operation done position of file end " + positionoffileend ; filehandleread close ; console log "file is now closed" ; output example string has been written to the file seek operation done position of file end 29 file is now closed closenonblocking closes file handle void closenonblocking optional successcallback? onsuccess, optional errorcallback? onerror ; since 5 0 closes the given file stream closing file guarantees writing changes made to filehandle to the storage device further operations on this file handle are not allowed successful closing invokes onsuccess function, if specified in case of failure onerror function is invoked, if specified the errorcallback is launched with these error types ioerror, if close fails or any error related to file handle occurs this method is asynchronous its execution will occur in background and after all previously commissioned background jobs will finish parameters onsuccess [optional] [nullable] callback function to be invoked on success onerror [optional] [nullable] callback function to be invoked when an error occurs exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter code example /* opening file for write - file is created if not exists, */ /* otherwise existing file is truncated */ var filehandlewrite = tizen filesystem openfile "documents/file", "w" ; filehandlewrite writestringnonblocking "lorem ipsum dolor sit amet ", function bytescount { console log "number of bytes written " + bytescount ; }, function error { console log error ; } ; filehandlewrite closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; /* opening file for read - this code assumes that there is */ /* a file named "file" in documents directory */ var filehandleread = tizen filesystem openfile "documents/file", "r" ; var positionoffileend = filehandleread seeknonblocking 0, function new_position { console log "moved to position " + new_position ; }, function error { console log error ; }, "end" ; filehandleread closenonblocking function { console log "file handle closed" ; }, function error { console log error ; } ; output example number of bytes written 29 file handle closed moved to position 29 file handle closed 2 5 file the file interface represents the file abstraction in use deprecated since 5 0 [nointerfaceobject] interface file { readonly attribute file? parent; readonly attribute boolean readonly; readonly attribute boolean isfile; readonly attribute boolean isdirectory; readonly attribute date? created; readonly attribute date? modified; readonly attribute domstring path; readonly attribute domstring name; readonly attribute domstring fullpath; readonly attribute unsigned long long filesize; readonly attribute long length; domstring touri raises webapiexception ; void listfiles filearraysuccesscallback onsuccess, optional errorcallback? onerror, optional filefilter? filter raises webapiexception ; void openstream filemode mode, filestreamsuccesscallback onsuccess, optional errorcallback? onerror, optional domstring? encoding raises webapiexception ; void readastext filestringsuccesscallback onsuccess, optional errorcallback? onerror, optional domstring? encoding raises webapiexception ; void copyto domstring originfilepath, domstring destinationfilepath, boolean overwrite, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void moveto domstring originfilepath, domstring destinationfilepath, boolean overwrite, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; file createdirectory domstring dirpath raises webapiexception ; file createfile domstring relativefilepath raises webapiexception ; file resolve domstring filepath raises webapiexception ; void deletedirectory domstring directorypath, boolean recursive, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void deletefile domstring filepath, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; }; since 1 0 the file object permissions for the file object location and tree rooted at that location depend upon the mode defined in the resolve method when a file object creates a child file object, the new file object inherits its access rights from the parent object without any reference to the security framework, as noted in certain methods of file a file handle represents either a file or a directory for a file, the isfile attribute is set to true for a directory, the isdirectory attribute is set to true a file can be opened for both read and write operations, using a filestream handle a list of files and sub-directories can be obtained from a directory and a resolve method exists to resolve files or sub-directories more conveniently than processing directory listings a file handle representing a file can be opened for i/o operations, such as reading and writing a file handle representing a directory can be used for listing all files and directories rooted as the file handle location code example function onsuccess files { for var i = 0; i < files length; i++ { /* alerts each name of dir's content */ console log files[i] name ; } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } /* list directory content */ dir listfiles onsuccess, onerror ; attributes readonly file parent [nullable] the parent directory handle deprecated since 5 0 this attribute is set to null if there is no parent directory this also implies that this directory represents a root location since 1 0 code example /* list directory content */ dir listfiles onsuccess, onerror ; function onsuccess files { for var i = 0; i < files length; i++ { /* prints the file parent, must contain the */ /* same value for all the files in the loop */ console log "all the files should have the same parent " + files[i] parent ; } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } readonly boolean readonly the file/directory access state in the filesystem deprecated since 5 0 this attribute is set to true - if object has read-only access at its location false - if object has write access at its location this attribute represents the actual state of a file or directory in the filesystem its value is not affected by the mode used in filesystemmanager resolve that was used to create the file object from which this file object was obtained since 1 0 code example /* lists directory content */ dir listfiles onsuccess, onerror ; function onsuccess files { for var i = 0; i < files length; i++ { if files[i] readonly console log "cannot write to file " + files[i] name ; else console log "can write to file " + files[i] name ; } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } readonly boolean isfile the flag indicating whether it is a file deprecated since 5 0 this attribute can have the following values true if this handle is a file false if this handle is a directory since 1 0 readonly boolean isdirectory the flag indicating whether it is a directory deprecated since 5 0 this attribute can have the following values true if this handle is a directory false if this handle is a file since 1 0 readonly date created [nullable] the timestamp when a file is first created in the filesystem deprecated since 5 0 this timestamp is equivalent to the timestamp when a call to createfile succeeds if the platform does not support this attribute, it will be null it is unspecified and platform-dependent if the creation timestamp changes when a file is moved since 1 0 readonly date modified [nullable] the timestamp when the most recent modification is made to a file, usually when the last write operation succeeds deprecated since 5 0 opening a file for reading does not change the modification timestamp if the platform does not support this attribute, it will be null it is unspecified and platform-dependent if the modified timestamp changes when a file is moved since 1 0 code example console log file modified ; /* displays the modification timestamp */ readonly domstring path the path of a file after excluding its file name deprecated since 5 0 it begins with the name of the root containing the file, followed by the path, including the directory containing the file, but excluding the file name except in some special cases of the file representing the root itself, the last character is always "/" for example, if a file is located at music/ramones/volume1/rockawaybeach mp3, the path is music/ramones/volume1/ for example, if a directory is located at music/ramones/volume1, the path is music/ramones/ for the virtual roots, the path is same as the name of the virtual root for example, if the root is music, then the path is music if the root is documents, then the path is documents since 1 0 code example console log file path ; /* must be music/ if the file is music/foo mp3 */ readonly domstring name the file name after excluding the root name and any path components deprecated since 5 0 this is the name of this file, excluding the root name and any other path components for example, if a file is located at music/ramones/volume1/rockawaybeach mp3, the name is "rockawaybeach mp3" for example, if a directory is located at music/ramones/volume1, the name is be "volume1" for the special case of the root itself, the name is an empty string since 1 0 code example /* must be foo mp3 if the file path is music/foo mp3 */ console log file name ; readonly domstring fullpath the full path of a file deprecated since 5 0 it begins with the name of the root containing the file, and including the name of the file or directory itself for instance, if the rockawaybeach mp3 file is located at music/ramones/volume1/, then the fullpath is music/ramones/volume1/rockawaybeach mp3 for a directory, if the volume1 directory is located at music/ramones/, then the fullpath is music/ramones/volume1 for the special case of the root itself, if the root is music, then the fullpath is music the fullpath is always equal to path + name since 1 0 code example /* must be music/track1 mp3 if the file is music/track1 mp3 */ console log file fullpath ; readonly unsigned long long filesize the size of this file, in bytes deprecated since 5 0 if an attempt to read this attribute for a directory is made, undefined is returned to retrieve the number of files and directories contained in the directory, use the length attribute since 1 0 code example /* displays the file size */ console log file filesize ; readonly long length the number of files and directories contained in a file handle deprecated since 5 0 if an attempt to read this attribute for a file is made, undefined is returned to retrieve the size of a file, use the filesize attribute since 1 0 code example /* "3" if the directory contains two files and one sub-directory */ console log file length ; methods touri returns a uri for a file to identify an entry such as using it as the src attribute on an html img element the uri has no specific expiration, it should be valid at least as long as the file exists deprecated since 5 0 domstring touri ; since 1 0 if that uri corresponds to any of the public virtual roots that is images, videos, music, documents and downloads the uri must be globally unique and could be used by any widget if that uri corresponds to a file located in any a widget's private areas such as wgt-package, wgt-private, wgt-private-tmp , the generated uri must be unique for that file and for the widget making the request such as including some derived from the widget id in the uri these uris must not be accessible to other widgets, apart from the one invoking this method privilege level public privilege http //tizen org/privilege/filesystem read return value domstring uri that identifies the file or null if an error occurs exceptions webapiexception with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges with error type unknownerror, if any other error occurred code example tizen filesystem resolve "music/ramones/rockawaybeach mp3", function file { var audio = new audio file touri ; audio play ; console log file touri ; } ; listfiles lists all files in a directory deprecated since 5 0 void listfiles filearraysuccesscallback onsuccess, optional errorcallback? onerror, optional filefilter? filter ; since 1 0 the list of files is passed as a file[] in onsuccess and contains directories and files however, the directories " " and " " must not be returned each file object that is part of the array must inherit all the access rights that is, one of the values in filemode from the file object in which this method is invoked if the filter is passed and contains valid values, only those directories and files in the directory that match the filter criteria specified in the filefilter interface must be returned in the onsuccess method if no filter is passed, the filter is null or undefined, or the filter contains invalid values, the implementation must return the full list of files in the directory if the directory does not contain any files or directories, or the filter criteria do not match any files or directories, the onsuccess is invoked with an empty array the errorcallback is launched with these error types ioerror - if the operation is launched on a file not a directory invalidvalueserror - if any of the input parameters contain an invalid value unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read parameters onsuccess callback method to be invoked when the list operation has been successfully completed onerror [optional] [nullable] callback method to be invoked when an error has occurred filter [optional] [nullable] criteria to restrict the listed files exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example function onsuccess files { console log "there are " + files length + " in the selected folder" ; } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "r" ; openstream opens the file in the given mode supporting a specified encoding deprecated since 5 0 void openstream filemode mode, filestreamsuccesscallback onsuccess, optional errorcallback? onerror, optional domstring? encoding ; since 1 0 this operation is performed asynchronously if the file is opened successfully, the onsuccess method is invoked with a filestream that can be used for reading and writing the file, depending on the mode the returned filestream instance includes a file pointer, which represents the current position in the file the file pointer, by default, is at the start of the file, except in the case of opening a file in append "a" mode, in which case the file pointer points to the end of the file the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value ioerror - the operation is launched on a directory not a file , the file is not valid or it does not exist unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read parameters mode mode in which the file is opened "r" for reading "a" for appending "w" for [over]writing "rw" for reading and writing onsuccess callback method to be invoked when a file has been opened onerror [optional] [nullable] callback method to be invoked when an error has occurred encoding [optional] [nullable] encoding to use for read/write operations on the file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin1 encoding if no encoding is passed by the developer, then the default platform encoding must be used exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { console log "file name is " + files[i] name ; /* displays file name */ } var testfile = documentsdir createfile "test txt" ; if testfile != null { testfile openstream "w", function fs { fs write "helloworld" ; fs close ; }, function e { console log "error " + e message ; }, "utf-8" ; } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; readastext reads the content of a file as a domstring deprecated since 5 0 void readastext filestringsuccesscallback onsuccess, optional errorcallback? onerror, optional domstring? encoding ; since 1 0 if the operation is successfully executed, the onsuccess method is invoked and a domstring is passed as input parameter that represents the file content in the format determined by the encoding parameter the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value ioerror - if the operation is launched on a directory not a file , the file is not valid, or the file does not exist unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem read parameters onsuccess callback method to be invoked when a file has been successfully read onerror [optional] [nullable] callback method to be invoked when an error occurs while reading a file encoding [optional] [nullable] encoding for read/write operations on a file, at least the following encodings must be supported "utf-8" default encoding "iso-8859-1" latin1 encoding if no encoding is passed by the developer, then the default platform encoding must be used exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { console log "file name is " + files[i] name ; /* displays file name */ if files[i] isdirectory == false { files[i] readastext function str { console log "the file content " + str ; }, function e { console log "error " + e message ; }, "utf-8" ; } } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; copyto copies and overwrites if possible and specified a file or a directory from a specified location to another specified location deprecated since 5 0 void copyto domstring originfilepath, domstring destinationfilepath, boolean overwrite, optional successcallback? onsuccess, optional errorcallback? onerror ; since 1 0 the copy of the file or directory identified by the originfilepath parameter must be created in the path passed in the destinationfilepath parameter the file or directory to copy must be under the directory from which the method is invoked, otherwise the operation must not be performed if the copy is performed successfully, the onsuccess method is invoked the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value notfounderror - if the originfilepath does not correspond to a valid file or destinationpath is not a valid path ioerror - if the file in which the copyto method is invoked is a file and not a directory , originfilepath corresponds to a file or directory in use by another process, overwrite parameter is false and destinationfilepath corresponds to an existing file or directory unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem write parameters originfilepath origin full virtual file or directory path and it must be under the current directory destinationfilepath new full virtual file path or directory path overwrite attribute to determine whether overwriting is allowed or not if set to true, it enforces overwriting an existing file onsuccess [optional] [nullable] callback method to be invoked when the file has been copied onerror [optional] [nullable] callback method to be invoked when an error has occurred exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { if files[i] isdirectory == false { documentsdir copyto files[i] fullpath, "images/backup/" + files[i] name, false, function { console log "file copied" ; } ; } } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; moveto moves and overwrites if possible and specified a file or a directory from a specified location to another this operation is different from instantiating copyto and then deleting the original file, as on certain platforms, this operation does not require extra disk space deprecated since 5 0 void moveto domstring originfilepath, domstring destinationfilepath, boolean overwrite, optional successcallback? onsuccess, optional errorcallback? onerror ; since 1 0 the file or directory identified by the originfilepath parameter is moved to the path passed in the destinationfilepath parameter the file to move must be under the directory from which the method is invoked, else the operation can not be performed if the file or directory is moved successfully, the onsuccess method is invoked the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value notfounderror - if originfilepath does not correspond to a valid file or destinationpath is not a valid path ioerror - if the file in which the moveto method is invoked is a file not a directory , originfilepath corresponds to a file or directory in use by another process, overwrite parameter is false and destinationfilepath corresponds to an existing file or directory unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem write parameters originfilepath origin full virtual file or directory path and it must be under the current directory destinationfilepath new full virtual file path or directory path overwrite flag indicating whether to overwrite an existing file when set to true, the files can be overwritten onsuccess [optional] [nullable] callback method to be invoked when the file has been moved onerror [optional] [nullable] callback method to be invoked when an error has occurred exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { if files[i] isdirectory == false { documentsdir moveto files[i] fullpath, "images/newfolder/" + files[i] name, false, function { console log "file moved" ; } ; } } } function onerror error { console log "the error " + error message + " occurred during listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; createdirectory creates a new directory deprecated since 5 0 file createdirectory domstring dirpath ; since 1 0 a new directory will be created relative to the current directory that this operation is performed on the implementation will attempt to create all necessary sub-directories specified in the dirpath, as well the use of " " or " " in path components is not supported this operation can only be performed on file handles that represent directories that is, isdirectory == true if the directory is successfully created, it will be returned in case the directory cannot be created, an error must be thrown with the appropriate error type privilege level public privilege http //tizen org/privilege/filesystem write parameters dirpath relative directory path and it only contains characters supported by the underlying filesystem return value file file handle of the new directory the new file object has "rw" access rights, as it inherits this from the file object on which the createdirectory method is called exceptions webapiexception with error type ioerror, if the dirpath already exists, if the file in which the createdirectory method is invoked is a file and not a directory with error type invalidvalueserror, if the dirpath does not contain a valid path with error type typemismatcherror, if the input parameter is not compatible with the expected type with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type unknownerror, if any other error occurs code example var dir; /* directory object obtained from filesystem api */ var newdir = dir createdirectory "newdir" ; var anothernewdir = dir createdirectory "newdir1/subnewdir1" ; createfile creates a empty new file in a specified location that is relative to the directory indicated by current file object's path attribute deprecated since 5 0 file createfile domstring relativefilepath ; since 1 0 the use of " " or " " in path components is not supported this operation can only be performed on file handlers that represent a directory that is, isdirectory == true if the file is successfully created, a file handle must be returned by this method in case the file cannot be created, an error must be thrown with the appropriate error type privilege level public privilege http //tizen org/privilege/filesystem write parameters relativefilepath new file path and it should only contain characters supported by the underlying filesystem return value file file handle for the new empty file the new file object has "rw" access rights, as it inherits this from the file object on which the createfile method is called exceptions webapiexception with error type ioerror, if relativefilepath already exists, if the file in which the createfile method is invoked is a file not a directory with error type invalidvalueserror, if relativefilepath contains an invalid value with error type typemismatcherror, if the input parameter is not compatible with the expected type with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges with error type unknownerror, if any other error occurs code example var newfile = dir createfile "newfilepath" ; resolve resolves an existing file or directory relative to the current directory this operation is performed on and returns a file handle for it deprecated since 5 0 file resolve domstring filepath ; since 1 0 the filepath is not allowed to contain the " " or " " directory entries inside its value the encoding of file paths is utf-8 privilege level public privilege http //tizen org/privilege/filesystem read parameters filepath relative file path or file uri to resolve return value file file handle of the file the new file object inherits its access rights from the file object on which this resolve method is called exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type invalidvalueserror, if the file path contains an invalid value with error type ioerror, if the method is executed in a file object that does not represent a directory that is, isdirectory attribute is false with error type notfounderror, if a file does not exist for the passed file path with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges with error type unknownerror, if any other error occurs code example var file; /* resolves helloworld doc file that is located in the */ /* documents root location */ tizen filesystem resolve "documents", function dir { file = dir resolve "helloworld doc" ; }, function e { console log "error " + e message ; }, "rw" ; deletedirectory deletes a specified directory and directory tree if specified deprecated since 5 0 void deletedirectory domstring directorypath, boolean recursive, optional successcallback? onsuccess, optional errorcallback? onerror ; since 1 0 this method attempts to asynchronously delete a directory or directory tree under the current directory if the recursive parameter is set to true, all the directories and files under the specified directory must be deleted if the recursive parameter is set to false, the directory is only deleted if it is empty, otherwise an ioerror error type will be passed in onerror if the deletion is performed successfully, the onsuccess is invoked the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value notfounderror -if the passed directory does not correspond to a valid directory ioerror - if the file in which the delete method is invoked is a file and not a directory , the directory is in use by another process or the directory is not empty and recursive argument is false this code is also used if a recursive deletion partially fails and any data deleted so far cannot be recovered this may occur due to the lack of filesystem permissions or if any directories or files are already opened by other processes unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem write parameters directorypath full virtual path to the directory to delete must be under the current one recursive flag indicating whether the deletion is recursive or not when set to true recursive deletion is allowed also, this function deletes all data in all subdirectories and so needs to be used with caution onsuccess [optional] [nullable] callback method to be invoked when a directory is successfully deleted onerror [optional] [nullable] callback method to be invoked when an error has occurred exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { if files[i] isdirectory { documentsdir deletedirectory files[i] fullpath, false, function { console log "directory deleted" ; }, function e { console log "error " + e message ; } ; } } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; deletefile deletes a specified file this function attempts to asynchronously delete a file under the current directory deprecated since 5 0 void deletefile domstring filepath, optional successcallback? onsuccess, optional errorcallback? onerror ; since 1 0 if the deletion is performed successfully, the onsuccess is invoked the errorcallback is launched with these error types invalidvalueserror - if any of the input parameters contains an invalid value notfounderror - if the file does not correspond to a valid file ioerror - if the file in which the delete method is invoked is a file not a directory , the file is in use by another process, or there is no permission in the file system unknownerror - if any other error occurs privilege level public privilege http //tizen org/privilege/filesystem write parameters filepath full virtual path to the file to delete must be under the current directory onsuccess [optional] [nullable] callback method to be invoked when the file is successfully deleted onerror [optional] [nullable] callback method to be invoked when an error has occurred exceptions webapiexception with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method or the application does not have privilege to access the storage for more information, see storage privileges code example var documentsdir; function onsuccess files { for var i = 0; i < files length; i++ { if !files[i] isdirectory { documentsdir deletefile files[i] fullpath, function { console log "file deleted" ; }, function e { console log "error " + e message ; } ; } } } function onerror error { console log "the error " + error message + " occurred when listing the files in the selected folder" ; } tizen filesystem resolve "documents", function dir { documentsdir = dir; dir listfiles onsuccess, onerror ; }, function e { console log "error " + e message ; }, "rw" ; 2 6 filefilter the dictionary that defines attributes to filter the items returned by the listdirectory method or deprecated listfiles dictionary filefilter { domstring name; boolean isfile; boolean isdirectory; date startmodified; date endmodified; date startcreated; date endcreated; }; since 1 0 when this dictionary is passed to a method, the result-set of the method will only contain file item entries that match the attribute values of the filter a file item only matches the filefilter object if all of the defined filter's attribute values match all of the file item's attributes only matching values other than undefined or null this is similar to a sql's "and" operation an attribute of the file entry matches the filefilter attribute value in accordance with the following rules for filefilter attributes of type domstring, an entry matches this value only if its corresponding attribute is an exact match if the filter contains u+0025 "percent sign" it is interpreted as a wildcard character and "%" matches any string of any length, including no length if wildcards are used, the behavior is similar to the like condition in sql to specify that a "percent sign" character is to be considered literally instead of interpreting it as a wildcard, developers can escape it with the backslash character please, remember that the backslash character has to be escaped itself, to not to be removed from the string - proper escaping of the "percent sign" in javascript string requires preceding it with double backslash "%" the matching is not case sensitive, such as "foo" matches a "foo" or an "f%" filter for file entry attributes of type date, attributes start and end are included to allow filtering of file entries between two supplied dates if either or both of these attributes are specified, the following rules apply a if both start and end dates are specified that is, other than null , a file entry matches the filter if its corresponding attribute is the same as either start or end or between the two supplied dates that is, after start and before end b if only the start attribute contains a value other than null , a file entry matches the filter if its corresponding attribute is later than or equal to the start one c if only the end date contains a value other than null , a file matches the filter if its corresponding attribute is earlier than or equal to the end date dictionary members domstring name the file name attribute filter files that have a name that corresponds with this attribute either exactly or with the specified wildcards match this filtering criteria since 1 0 boolean isfile if true match only files if false do not match files may be undefined since 5 0 boolean isdirectory if true match only directories, if false do not match directories may be undefined since 5 0 date startmodified the file modified attribute filter files with modified date later than this attribute or equal to it match the filtering criteria since 1 0 date endmodified the file modified attribute filter files with modified date earlier than this attribute or equal to it match the filtering criteria since 1 0 date startcreated the file created attribute filter files with created date later than this attribute or equal to it match the filtering criteria since 1 0 date endcreated the file created attribute filter files with created date earlier than this attribute or equal to it match the filtering criteria since 1 0 2 7 filestream the filestream interface represents a handle to a file opened for read and/or write operations read and write operations are performed relative to a position attribute, which is a pointer that represents the current position in the file deprecated since 5 0 [nointerfaceobject] interface filestream { readonly attribute boolean eof; attribute long position; readonly attribute long bytesavailable; void close ; domstring read long charcount raises webapiexception ; octet[] readbytes long bytecount raises webapiexception ; domstring readbase64 long bytecount raises webapiexception ; void write domstring stringdata raises webapiexception ; void writebytes octet[] bytedata raises webapiexception ; void writebase64 domstring base64data raises webapiexception ; }; since 1 0 a series of read/write methods are available that permit both binary and text to be processed once a file stream is closed, any operation attempt made on this stream results in a standard javascript error the read/write operations in this interface do not throw any security exceptions as the access rights are expected to be granted through the initial resolve method or through the openstream method of the file interface therefore, all actions performed on a successfully resolved file and filestream are expected to succeed this avoids successive asynchronous calls and may potentially increase application for a user attributes readonly boolean eof the flag indicating whether the current file pointer is at the end of the file deprecated since 5 0 if set to true, this attribute indicates that the file pointer is at the end of the file if set to false, this attribute indicates that the file pointer is not at the end of the file and so it is anywhere within the file since 1 0 code example if stream eof { /* file has been read completely */ } long position the flag indicating the stream position for reads/writes deprecated since 5 0 the stream position is an offset of bytes from the start of the file stream when invoking an operation that reads or writes from the stream, the operation will take place from the byte defined by this position attribute if the read or write operation is successful, the position of the stream is advanced by the number of bytes read or written if the read/write operation is not successful, the position of the stream is unchanged since 1 0 code example console log stream position ; /* displays current stream position */ /* alters current stream position to the begin of the file, */ /* like seek in c */ stream position = 0; readonly long bytesavailable the number of bytes that are available for reading from the stream deprecated since 5 0 the number of bytes available for reading is the maximum amount of bytes that can be read in the next read operation it corresponds to the number of bytes available after the file pointer denoted by the position attribute -1 if eof is true since 1 0 code example console log stream bytesavailable ; /* displays the available bytes to be read */ methods close closes this filestream deprecated since 5 0 void close ; since 1 0 flushes any pending buffered writes and closes the file always succeeds note that pending writes might not succeed privilege level public privilege http //tizen org/privilege/filesystem read code example stream close ; /* closes this stream, no subsequent access to stream allowed */ read reads the specified number of characters from the position of the file pointer in a filestream and returns the characters as a string the resulting string length might be shorter than charcount if eof is true deprecated since 5 0 domstring read long charcount ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters charcount number of characters being read return value domstring array of read characters as a string exceptions webapiexception with error type ioerror, if a read error occurs, such as the bytes in the stream cannot be decoded with the encoding in use with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type invalidvalueserror, if any of the input parameters contains an invalid value with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example var text = stream read file filesize ; stream close ; readbytes reads the specified number of bytes from a filestream deprecated since 5 0 octet[] readbytes long bytecount ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters bytecount number of bytes to read return value octet[] result of read bytes as a byte or number array exceptions webapiexception with error type ioerror, if a read error occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type invalidvalueserror, if any of the input parameters contains an invalid value with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example /* reads up to 256 bytes from the stream */ var raw = stream readbytes 256 ; for var i = 0; i < raw length; i++ { /* raw[i] contains the i-th byte of the current data chunk */ } readbase64 reads the specified number of bytes from this filestream, encoding the result in base64 deprecated since 5 0 domstring readbase64 long bytecount ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem read parameters bytecount number of bytes to read return value domstring array of read characters as base64 encoding string exceptions webapiexception with error type ioerror, if a read error occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type invalidvalueserror, if any of the input parameters contains an invalid value with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example /* reads up to 256 bytes from the stream */ var base64 = stream readbase64 256 ; write writes the specified domstring to a filestream deprecated since 5 0 void write domstring stringdata ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem write parameters stringdata actual string to write exceptions webapiexception with error type ioerror, if a write error occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example var text = "hello world"; stream write text ; writebytes writes the specified bytes to this filestream deprecated since 5 0 void writebytes octet[] bytedata ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem write parameters bytedata byte data array being written exceptions webapiexception with error type ioerror, if a write error occurs with error type typemismatcherror, if the input parameter is not compatible with the expected type for that parameter with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example var bytes = input readbytes 256 ; /* writes the bytes read from input to output */ output writebytes bytes ; writebase64 writes the result to this filestream after converting the specified base64 domstring to bytes deprecated since 5 0 void writebase64 domstring base64data ; since 1 0 privilege level public privilege http //tizen org/privilege/filesystem write parameters base64data the base64 data to written exceptions webapiexception with error type ioerror, if an error occurs during writebase64 with error type invalidvalueserror, if the input parameter contains an invalid value e g the base64data input parameter is not a valid base64 sequence with error type securityerror, if the application does not have the privilege to call this method for more information, see storage privileges code example var base64 = input readbase64 256 ; /* writes the base64 data read from input to output */ output writebase64 base64 ; 2 8 filesuccesscallback the filesuccesscallback interface defines file system success callback with a file object as input argument deprecated since 5 0 [callback=functiononly, nointerfaceobject] interface filesuccesscallback { void onsuccess file file ; }; since 1 0 it is used in asynchronous operations, such as filesystemmanager resolve , copying, moving and deleting files methods onsuccess called when the asynchronous call completes successfully deprecated since 5 0 void onsuccess file file ; since 1 0 parameters file file resulting from the asynchronous call 2 9 filesystemstoragearraysuccesscallback the filesystemstoragearraysuccesscallback callback interface specifies a success callback with an array of filesystemstorage objects as input argument [callback=functiononly, nointerfaceobject] interface filesystemstoragearraysuccesscallback { void onsuccess filesystemstorage[] storages ; }; since 1 0 it is used in asynchronous operations, such as filesystemmanager liststorages methods onsuccess called when the asynchronous call completes successfully void onsuccess filesystemstorage[] storages ; since 1 0 parameters storages list of available storage devices 2 10 filesystemstoragesuccesscallback the filesystemstoragesuccesscallback callback interface specifies a success callback with a filesystemstorage object as input argument [callback=functiononly, nointerfaceobject] interface filesystemstoragesuccesscallback { void onsuccess filesystemstorage storage ; }; since 1 0 it is used in asynchronous operations, such as filesystemmanager getstorage and filesystemmanager addstoragestatechangelistener methods onsuccess called when the asynchronous call completes successfully void onsuccess filesystemstorage storage ; since 1 0 parameters storage storage device structure 2 11 pathsuccesscallback the pathsuccesscallback callback interface specifies a success callback with a path value as input argument [callback=functiononly, nointerfaceobject] interface pathsuccesscallback { void onsuccess path path ; }; since 5 0 it is used in asynchronous operations of the filesystemmanager interface methods onsuccess called when the asynchronous call completes successfully void onsuccess path path ; since 5 0 parameters path path to created or changed resource on the filesystem in case of deletion, path to parent of the deleted resource is given 2 12 seeksuccesscallback the seeksuccesscallback callback interface specifies a success callback with a long long value as input argument [callback=functiononly, nointerfaceobject] interface seeksuccesscallback { void onsuccess long long position ; }; since 5 0 it is used in asynchronous operation filehandle seeknonblocking methods onsuccess called when the asynchronous call completes successfully void onsuccess long long position ; since 5 0 parameters position file position indicator 2 13 readstringsuccesscallback the readstringsuccesscallback callback interface specifies a success callback with a domstring value as input argument [callback=functiononly, nointerfaceobject] interface readstringsuccesscallback { void onsuccess domstring string ; }; since 5 0 it is used in asynchronous operation filehandle readstringnonblocking methods onsuccess called when the asynchronous call completes successfully void onsuccess domstring string ; since 5 0 parameters string string with data read from file 2 14 writestringsuccesscallback the writestringsuccesscallback callback interface specifies a success callback with a long long value as input argument [callback=functiononly, nointerfaceobject] interface writestringsuccesscallback { void onsuccess long long bytescount ; }; since 5 0 it is used in asynchronous operation filehandle writestringnonblocking methods onsuccess called when the asynchronous call completes successfully void onsuccess long long bytescount ; since 5 0 parameters bytescount number of bytes written can be more than inputstring length for multibyte encodings and will never be less 2 15 readblobsuccesscallback the readblobsuccesscallback callback interface specifies a success callback with a blob object as input argument [callback=functiononly, nointerfaceobject] interface readblobsuccesscallback { void onsuccess blob blob ; }; since 5 0 it is used in asynchronous operation filehandle readblobnonblocking methods onsuccess called when the asynchronous call completes successfully void onsuccess blob blob ; since 5 0 parameters blob blob object with file content 2 16 readdatasuccesscallback the readdatasuccesscallback callback interface specifies a success callback with a uint8array value as input argument [callback=functiononly, nointerfaceobject] interface readdatasuccesscallback { void onsuccess uint8array data ; }; since 5 0 it is used in asynchronous operation filehandle readdatanonblocking methods onsuccess called when the asynchronous call completes successfully void onsuccess uint8array data ; since 5 0 parameters data a typedarray with file content 2 17 filestringsuccesscallback the filestringsuccesscallback callback interface specifies a success callback with a domstring object as input argument deprecated since 5 0 [callback=functiononly, nointerfaceobject] interface filestringsuccesscallback { void onsuccess domstring filestr ; }; since 1 0 it is used in asynchronous operation file readastext methods onsuccess called when the asynchronous call completes successfully deprecated since 5 0 void onsuccess domstring filestr ; since 1 0 parameters filestr file represented as a domstring resulting from the asynchronous call 2 18 filestreamsuccesscallback the filestreamsuccesscallback interface specifies a success callback with a filestream object as input argument deprecated since 5 0 [callback=functiononly, nointerfaceobject] interface filestreamsuccesscallback { void onsuccess filestream filestream ; }; since 1 0 it is used in asynchronous operation file openstream methods onsuccess called when the file openstream asynchronous call completes successfully deprecated since 5 0 void onsuccess filestream filestream ; since 1 0 parameters filestream filestream to access file content 2 19 listdirectorysuccesscallback the listdirectorysuccesscallback interface defines success callback for listing methods [callback=functiononly, nointerfaceobject] interface listdirectorysuccesscallback { void onsuccess domstring[] names, path path ; }; since 5 0 this callback interface specifies a success callback with a function taking an array of strings as input argument it is used in asynchronous operation filesystemmanager listdirectory methods onsuccess called when the asynchronous call completes successfully void onsuccess domstring[] names, path path ; since 5 0 parameters names file or directory names resulting from the asynchronous call path path to listed directory 2 20 filearraysuccesscallback the filearraysuccesscallback interface defines file system specific success callback for listing methods deprecated since 5 0 [callback=functiononly, nointerfaceobject] interface filearraysuccesscallback { void onsuccess file[] files ; }; since 1 0 this callback interface specifies a success callback with a function taking an array of file objects as input argument it is used in asynchronous methods, such as file listfiles methods onsuccess called when the asynchronous call completes successfully deprecated since 5 0 void onsuccess file[] files ; since 1 0 parameters files files resulting from the asynchronous call 3 full webidl module filesystem { typedef domstring path; typedef blob blob; enum filemode { "a", "r", "rw", "rwo", "w" }; enum filesystemstoragetype { "internal", "external" }; enum filesystemstoragestate { "mounted", "removed", "unmountable" }; enum baseseekposition { "begin", "current", "end" }; dictionary filefilter { domstring name; boolean isfile; boolean isdirectory; date startmodified; date endmodified; date startcreated; date endcreated; }; tizen implements filesystemmanagerobject; [nointerfaceobject] interface filesystemmanagerobject { readonly attribute filesystemmanager filesystem; }; [nointerfaceobject] interface filesystemmanager { readonly attribute long maxnamelength; readonly attribute long maxpathlength; filehandle openfile path path, filemode openmode, optional boolean makeparents raises webapiexception ; void createdirectory path path, optional boolean makeparents, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void deletefile path path, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void deletedirectory path path, optional boolean recursive, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void copyfile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void copydirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void movefile path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void movedirectory path sourcepath, path destinationpath, optional boolean overwrite, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void rename path path, domstring newname, optional pathsuccesscallback? successcallback, optional errorcallback? errorcallback raises webapiexception ; void listdirectory path path, listdirectorysuccesscallback successcallback, optional errorcallback? errorcallback, optional filefilter? filter raises webapiexception ; domstring touri path path raises webapiexception ; boolean isfile path path raises webapiexception ; boolean isdirectory path path raises webapiexception ; boolean pathexists path path raises webapiexception ; domstring getdirname domstring path ; void getstorage domstring label, filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; void liststorages filesystemstoragearraysuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; long addstoragestatechangelistener filesystemstoragesuccesscallback onsuccess, optional errorcallback? onerror raises webapiexception ; void removestoragestatechangelistener long watchid raises webapiexception ; }; [nointerfaceobject] interface filesystemstorage { readonly attribute domstring label; readonly attribute filesystemstoragetype type; readonly attribute filesystemstoragestate state; }; [nointerfaceobject] interface filehandle { readonly attribute path path; long long seek long long offset, optional baseseekposition whence raises webapiexception ; void seeknonblocking long long offset, optional seeksuccesscallback? onsuccess, optional errorcallback? onerror, optional baseseekposition whence raises webapiexception ; domstring readstring optional long long? count, optional domstring inputencoding raises webapiexception ; void readstringnonblocking optional readstringsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long count, optional domstring inputencoding raises webapiexception ; long long writestring domstring inputstring, optional domstring outputencoding raises webapiexception ; void writestringnonblocking domstring inputstring, optional writestringsuccesscallback? onsuccess, optional errorcallback? onerror, optional domstring outputencoding raises webapiexception ; blob readblob optional long long size raises webapiexception ; void readblobnonblocking optional readblobsuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size raises webapiexception ; void writeblob blob blob raises webapiexception ; void writeblobnonblocking blob blob, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; uint8array readdata optional long long size raises webapiexception ; void readdatanonblocking optional readdatasuccesscallback? onsuccess, optional errorcallback? onerror, optional long long? size raises webapiexception ; void writedata uint8array data raises webapiexception ; void writedatanonblocking uint8array data, optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void flush raises webapiexception ; void flushnonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void sync raises webapiexception ; void syncnonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; void close raises webapiexception ; void closenonblocking optional successcallback? onsuccess, optional errorcallback? onerror raises webapiexception ; }; [callback=functiononly, nointerfaceobject] interface filesystemstoragearraysuccesscallback { void onsuccess filesystemstorage[] storages ; }; [callback=functiononly, nointerfaceobject] interface filesystemstoragesuccesscallback { void onsuccess filesystemstorage storage ; }; [callback=functiononly, nointerfaceobject] interface pathsuccesscallback { void onsuccess path path ; }; [callback=functiononly, nointerfaceobject] interface seeksuccesscallback { void onsuccess long long position ; }; [callback=functiononly, nointerfaceobject] interface readstringsuccesscallback { void onsuccess domstring string ; }; [callback=functiononly, nointerfaceobject] interface writestringsuccesscallback { void onsuccess long long bytescount ; }; [callback=functiononly, nointerfaceobject] interface readblobsuccesscallback { void onsuccess blob blob ; }; [callback=functiononly, nointerfaceobject] interface readdatasuccesscallback { void onsuccess uint8array data ; }; [callback=functiononly, nointerfaceobject] interface listdirectorysuccesscallback { void onsuccess domstring[] names, path path ; }; };