chromex.app.file-system — binaryage/chromex 0.7.1

clj

Use the chrome.fileSystem API to create, read, navigate, and write to the user's local file system. With this API, Chrome Apps can read and write to a user-selected location. For example, a text editor app can use the API to read and write local documents. All failures are notified via chrome.runtime.lastError.

• available since Chrome 27
• https://developer.chrome.com/apps/fileSystem

api-table clj

choose-entry clj/s macro

(choose-entry)

(choose-entry options)

Ask the user to choose a file or directory.

|options| - https://developer.chrome.com/apps/fileSystem#property-chooseEntry-options.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [entry file-entries] where:

|entry| - https://developer.chrome.com/apps/fileSystem#property-callback-entry. |file-entries| - https://developer.chrome.com/apps/fileSystem#property-callback-fileEntries.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/fileSystem#method-chooseEntry.

choose-entry* cljs

(choose-entry* config options)

gen-call clj

gen-wrap clj/s macro

(gen-wrap kind item-id config & args)

get-display-path clj/s macro

(get-display-path entry)

Get the display path of an Entry object. The display path is based on the full path of the file or directory on the local file system, but may be made more readable for display purposes.

|entry| - https://developer.chrome.com/apps/fileSystem#property-getDisplayPath-entry.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [display-path] where:

|display-path| - https://developer.chrome.com/apps/fileSystem#property-callback-displayPath.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/fileSystem#method-getDisplayPath.

get-display-path* cljs

(get-display-path* config entry)

get-volume-list clj/s macro

(get-volume-list)

Returns a list of volumes available for requestFileSystem(). The 'fileSystem': {'requestFileSystem'} manifest permission is required. Available to kiosk apps running in the kiosk session only. In case of an error, volumes will be undefined, and chrome.runtime.lastError will be set.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [volumes] where:

|volumes| - https://developer.chrome.com/apps/fileSystem#property-callback-volumes.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/fileSystem#method-getVolumeList.

get-volume-list* cljs

(get-volume-list* config)

get-writable-entry clj/s macro

(get-writable-entry entry)

Get a writable Entry from another Entry. This call will fail with a runtime error if the application does not have the 'write' permission under 'fileSystem'. If entry is a DirectoryEntry, this call will fail if the application does not have the 'directory' permission under 'fileSystem'.

|entry| - https://developer.chrome.com/apps/fileSystem#property-getWritableEntry-entry.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [entry] where:

|entry| - https://developer.chrome.com/apps/fileSystem#property-callback-entry.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/fileSystem#method-getWritableEntry.

get-writable-entry* cljs

(get-writable-entry* config entry)

is-restorable clj/s macro

(is-restorable id)

Returns whether the app has permission to restore the entry with the given id.

|id| - https://developer.chrome.com/apps/fileSystem#property-isRestorable-id.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [is-restorable] where:

|is-restorable| - https://developer.chrome.com/apps/fileSystem#property-callback-isRestorable.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/fileSystem#method-isRestorable.

is-restorable* cljs

(is-restorable* config id)

is-writable-entry clj/s macro

(is-writable-entry entry)

Gets whether this Entry is writable or not.

|entry| - https://developer.chrome.com/apps/fileSystem#property-isWritableEntry-entry.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [is-writable] where:

|is-writable| - https://developer.chrome.com/apps/fileSystem#property-callback-isWritable.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/fileSystem#method-isWritableEntry.

is-writable-entry* cljs

(is-writable-entry* config entry)

on-volume-list-changed* cljs

(on-volume-list-changed* config channel & args)

request-file-system clj/s macro

(request-file-system options)

Requests access to a file system for a volume represented by options.volumeId. If options.writable is set to true, then the file system will be writable. Otherwise, it will be read-only. The writable option requires the 'fileSystem': {'write'} permission in the manifest. Available to kiosk apps running in kiosk session only. For manual-launch kiosk mode, a confirmation dialog will be shown on top of the active app window. In case of an error, fileSystem will be undefined, and chrome.runtime.lastError will be set.

|options| - https://developer.chrome.com/apps/fileSystem#property-requestFileSystem-options.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [file-system] where:

|file-system| - https://developer.chrome.com/apps/fileSystem#property-callback-fileSystem.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/fileSystem#method-requestFileSystem.

request-file-system* cljs

(request-file-system* config options)

restore-entry clj/s macro

(restore-entry id)

Returns the file entry with the given id if it can be restored. This call will fail with a runtime error otherwise.

|id| - https://developer.chrome.com/apps/fileSystem#property-restoreEntry-id.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [entry] where:

|entry| - https://developer.chrome.com/apps/fileSystem#property-callback-entry.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/fileSystem#method-restoreEntry.

restore-entry* cljs

(restore-entry* config id)

retain-entry clj/s macro

(retain-entry entry)

Returns an id that can be passed to restoreEntry to regain access to a given file entry. Only the 500 most recently used entries are retained, where calls to retainEntry and restoreEntry count as use. If the app has the 'retainEntries' permission under 'fileSystem', entries are retained indefinitely. Otherwise, entries are retained only while the app is running and across restarts.

|entry| - https://developer.chrome.com/apps/fileSystem#property-retainEntry-entry.

https://developer.chrome.com/apps/fileSystem#method-retainEntry.

retain-entry* cljs

(retain-entry* config entry)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.app.file-system namespace.

tap-on-volume-list-changed-events clj/s macro

(tap-on-volume-list-changed-events channel & args)

Called when a list of available volumes is changed.

Events will be put on the |channel| with signature [::on-volume-list-changed [event]] where:

|event| - https://developer.chrome.com/apps/fileSystem#property-onVolumeListChanged-event.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/apps/fileSystem#event-onVolumeListChanged.