chromex.ext.image-writer-private — binaryage/chromex 0.9.3

clj

Use the chrome.image_writer API to write images to removable media.

See the design doc for a detailed description of this API. https://goo.gl/KzMEFq

• available since Chrome 36

api-table clj

cancel-write clj/s macro

(cancel-write)

Cancel a current write operation.

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 [].

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.

cancel-write* cljs

(cancel-write* config)

destroy-partitions clj/s macro

(destroy-partitions storage-unit-id)

Destroys the partition table of a disk, effectively erasing it. This is a fairly quick operation and so it does not have complex stages or progress information, just a write phase.

|storage-unit-id| - The identifier of the storage unit to wipe

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 [].

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.

destroy-partitions* cljs

(destroy-partitions* config storage-unit-id)

gen-call clj

gen-wrap clj/s macro

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

list-removable-storage-devices clj/s macro

(list-removable-storage-devices)

List all the removable block devices currently attached to the system.

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 [devices] where:

|devices| - ?

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.

list-removable-storage-devices* cljs

(list-removable-storage-devices* config)

on-device-inserted* cljs

(on-device-inserted* config channel & args)

on-device-removed* cljs

(on-device-removed* config channel & args)

on-write-complete* cljs

(on-write-complete* config channel & args)

on-write-error* cljs

(on-write-error* config channel & args)

on-write-progress* cljs

(on-write-progress* config channel & args)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.ext.image-writer-private namespace.

tap-on-device-inserted-events clj/s macro

(tap-on-device-inserted-events channel & args)

Fires when a removable storage device is inserted.

Events will be put on the |channel| with signature [::on-device-inserted [device]] where:

|device| - ?

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

tap-on-device-removed-events clj/s macro

(tap-on-device-removed-events channel & args)

Fires when a removable storage device is removed.

Events will be put on the |channel| with signature [::on-device-removed [device]] where:

|device| - ?

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

tap-on-write-complete-events clj/s macro

(tap-on-write-complete-events channel & args)

Fires when the write operation has completely finished, such as all devices being finalized and resources released.

Events will be put on the |channel| with signature [::on-write-complete []].

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

tap-on-write-error-events clj/s macro

(tap-on-write-error-events channel & args)

Fires when an error occured during writing, passing the 'ProgressInfo' of the operation at the time the error occured.

Events will be put on the |channel| with signature [::on-write-error [info error]] where:

|info| - ? |error| - ?

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

tap-on-write-progress-events clj/s macro

(tap-on-write-progress-events channel & args)

Fires periodically throughout the writing operation and at least once per stage.

Events will be put on the |channel| with signature [::on-write-progress [info]] where:

|info| - ?

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

write-from-file clj/s macro

(write-from-file storage-unit-id file-entry)

Write an image to the disk, prompting the user to supply the image from a local file. The callback will be called when the entire operation completes, either successfully or on error.

|storage-unit-id| - The identifier for the storage unit |file-entry| - The FileEntry object of the image to be burned.

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 [].

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.

write-from-file* cljs

(write-from-file* config storage-unit-id file-entry)

write-from-url clj/s macro

(write-from-url storage-unit-id image-url)

(write-from-url storage-unit-id image-url options)

Write an image to the disk downloaded from the provided URL. The callback will be called when the entire operation completes, either successfully or on error.

|storage-unit-id| - The identifier for the storage unit |image-url| - The url of the image to download which will be written to the storage unit identified by |storageUnitId

|options| - Optional parameters if comparing the download with a given hash or saving the download to the users Downloads folder instead of a temporary directory is desired

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 [].

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.

write-from-url* cljs

(write-from-url* config storage-unit-id image-url options)