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

clj

• available since Chrome 27

api-table clj

can-edit clj/s macro

(can-edit)

Whether bookmarks can be modified.

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-edit* cljs

(can-edit* config)

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)

create-with-meta-info clj/s macro

(create-with-meta-info bookmark meta-info)

Mimics the functionality of bookmarks.create, but will additionally set the given meta info fields.

|bookmark| - ? |meta-info| - ?

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.

create-with-meta-info* cljs

(create-with-meta-info* config bookmark meta-info)

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-meta-info clj/s macro

(get-meta-info)

(get-meta-info id)

(get-meta-info id key)

Gets meta info from a bookmark node.

|id| - The id of the bookmark to retrieve meta info from. If omitted meta info for all nodes is returned. |key| - The key for the meta info to retrieve. If omitted, all fields are returned.

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

|value| - If a key was given, the value of the specified field, if present. Otherwise an object containing all meta info fields for the node. If id is not given then meta info for all nodes as an object with node id to meta info.

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-meta-info* cljs

(get-meta-info* config id key)

get-redo-info clj/s macro

(get-redo-info)

Gets the information for the redo if available.

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.

get-redo-info* cljs

(get-redo-info* config)

get-strings clj/s macro

(get-strings)

Gets the i18n strings for the bookmark manager.

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.

get-strings* cljs

(get-strings* config)

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)

get-undo-info clj/s macro

(get-undo-info)

Gets the information for the undo if available.

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.

get-undo-info* cljs

(get-undo-info* config)

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)

on-meta-info-changed* cljs

(on-meta-info-changed* 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)

record-launch clj/s macro

(record-launch)

record-launch* cljs

(record-launch* config)

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)

set-meta-info clj/s macro

(set-meta-info id key value)

Sets a meta info value for a bookmark node.

|id| - The id of the bookmark node to set the meta info on. |key| - The key of the meta info to set. |value| - The meta info to 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 [].

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.

set-meta-info* cljs

(set-meta-info* config id key value)

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)

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.

start-drag* cljs

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

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.

tap-on-meta-info-changed-events clj/s macro

(tap-on-meta-info-changed-events channel & args)

Fired when the meta info of a node changes.

Events will be put on the |channel| with signature [::on-meta-info-changed [id meta-info-changes]] where:

|id| - ? |meta-info-changes| - ?

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)

update-meta-info clj/s macro

(update-meta-info id meta-info-changes)

Updates a set of meta info values for a bookmark node.

|id| - The id of the bookmark node to update the meta info of. |meta-info-changes| - A set of meta info key/value pairs to update.

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.

update-meta-info* cljs

(update-meta-info* config id meta-info-changes)