chromex.ext.bookmark-manager-private — binaryage/chromex 0.8.6

clj

• available since Chrome 34

api-table clj

can-paste clj/s macro

(can-paste parent-id)

Whether there are any bookmarks that can be pasted.

|parent-id| - The ID of the folder to paste into.

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

|result| - ?

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.

can-paste* cljs

(can-paste* config parent-id)

copy clj/s macro

(copy id-list)

Copies the given bookmarks into the clipboard.

|id-list| - An array of string-valued ids

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.

copy* cljs

(copy* config id-list)

cut clj/s macro

(cut id-list)

Cuts the given bookmarks into the clipboard.

|id-list| - An array of string-valued ids

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.

cut* cljs

(cut* config id-list)

drop clj/s macro

(drop parent-id)

(drop parent-id index)

Performs the drop action of the drag and drop session.

|parent-id| - The ID of the folder that the drop was made. |index| - The index of the position to drop at. If left out the dropped items will be placed at the end of the existing children.

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.

drop* cljs

(drop* config parent-id index)

gen-call clj

gen-wrap clj/s macro

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

get-subtree clj/s macro

(get-subtree id folders-only)

Retrieves a bookmark hierarchy from the given node. If the node id is empty, it is the full tree. If foldersOnly is true, it will only return folders, not actual bookmarks.

|id| - ID of the root of the tree to pull. If empty, the entire tree will be returned. |folders-only| - Pass true to only return folders.

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

|results| - ?

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.

get-subtree* cljs

(get-subtree* config id folders-only)

on-drag-enter* cljs

(on-drag-enter* config channel & args)

on-drag-leave* cljs

(on-drag-leave* config channel & args)

on-drop* cljs

(on-drop* config channel & args)

paste clj/s macro

(paste parent-id)

(paste parent-id selected-id-list)

Pastes bookmarks from the clipboard into the parent folder after the last selected node.

|parent-id| - ? |selected-id-list| - An array of string-valued ids for selected bookmarks.

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.

paste* cljs

(paste* config parent-id selected-id-list)

redo clj/s macro

(redo)

Performs a redo of last undone change to the bookmark model.

redo* cljs

(redo* config)

remove-trees clj/s macro

(remove-trees id-list)

Recursively removes list of bookmarks nodes.

|id-list| - An array of string-valued ids.

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.

remove-trees* cljs

(remove-trees* config id-list)

sort-children clj/s macro

(sort-children parent-id)

Sorts the children of a given folder.

|parent-id| - The ID of the folder to sort the children of.

sort-children* cljs

(sort-children* config parent-id)

start-drag clj/s macro

(start-drag id-list drag-node-index is-from-touch x y)

Begins dragging a set of bookmarks.

|id-list| - An array of string-valued ids. |drag-node-index| - The index of the dragged node in |idList

|is-from-touch| - True if the drag was initiated from touch. |x| - The clientX of the dragStart event |y| - The clientY of the dragStart event

start-drag* cljs

(start-drag* config id-list drag-node-index is-from-touch x y)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.ext.bookmark-manager-private namespace.

tap-on-drag-enter-events clj/s macro

(tap-on-drag-enter-events channel & args)

Fired when dragging bookmarks over the document.

Events will be put on the |channel| with signature [::on-drag-enter [bookmark-node-data]] where:

|bookmark-node-data| - ?

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

tap-on-drag-leave-events clj/s macro

(tap-on-drag-leave-events channel & args)

Fired when the drag and drop leaves the document.

Events will be put on the |channel| with signature [::on-drag-leave [bookmark-node-data]] where:

|bookmark-node-data| - ?

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

tap-on-drop-events clj/s macro

(tap-on-drop-events channel & args)

Fired when the user drops bookmarks on the document.

Events will be put on the |channel| with signature [::on-drop [bookmark-node-data]] where:

|bookmark-node-data| - ?

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

undo clj/s macro

(undo)

Performs an undo of the last change to the bookmark model.

undo* cljs

(undo* config)