Liking cljdoc? Tell your friends :D

chromex.ext.bookmarks

clj

Use the chrome.bookmarks API to create, organize, and otherwise manipulate bookmarks. Also see Override Pages, which you can use to create a custom Bookmark Manager page.

Use the chrome.bookmarks API to create, organize, and otherwise manipulate bookmarks. Also see Override Pages, which you
can use to create a custom Bookmark Manager page.

  * available since Chrome 26
  * https://developer.chrome.com/extensions/bookmarks
raw docstring

api-tableclj

source

createclj/smacro

(create bookmark)

Creates a bookmark or folder under the specified parentId. If url is NULL or missing, it will be a folder.

|bookmark| - https://developer.chrome.com/extensions/bookmarks#property-create-bookmark.

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| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-create.

Creates a bookmark or folder under the specified parentId.  If url is NULL or missing, it will be a folder.

  |bookmark| - https://developer.chrome.com/extensions/bookmarks#property-create-bookmark.

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| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-create.
sourceraw docstring

create*cljs

(create* config bookmark)
source

gen-callclj

source

gen-wrapclj/smacro

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

getclj/smacro

(get id-or-id-list)

Retrieves the specified BookmarkTreeNode(s).

|id-or-id-list| - A single string-valued id, or 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 [results] where:

|results| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-get.

Retrieves the specified BookmarkTreeNode(s).

  |id-or-id-list| - A single string-valued id, or 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 [results] where:

  |results| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-get.
sourceraw docstring

get*cljs

(get* config id-or-id-list)
source

get-childrenclj/smacro

(get-children id)

Retrieves the children of the specified BookmarkTreeNode id.

|id| - https://developer.chrome.com/extensions/bookmarks#property-getChildren-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 [results] where:

|results| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-getChildren.

Retrieves the children of the specified BookmarkTreeNode id.

  |id| - https://developer.chrome.com/extensions/bookmarks#property-getChildren-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 [results] where:

  |results| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-getChildren.
sourceraw docstring

get-children*cljs

(get-children* config id)
source

get-max-sustained-write-operations-per-minuteclj/smacro

(get-max-sustained-write-operations-per-minute)
https://developer.chrome.com/extensions/bookmarks#property-MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE.
sourceraw docstring

get-max-write-operations-per-hourclj/smacro

(get-max-write-operations-per-hour)
https://developer.chrome.com/extensions/bookmarks#property-MAX_WRITE_OPERATIONS_PER_HOUR.
sourceraw docstring

get-recentclj/smacro

(get-recent number-of-items)

Retrieves the recently added bookmarks.

|number-of-items| - The maximum number of items to return.

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| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-getRecent.

Retrieves the recently added bookmarks.

  |number-of-items| - The maximum number of items to return.

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| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-getRecent.
sourceraw docstring

get-recent*cljs

(get-recent* config number-of-items)
source

get-sub-treeclj/smacro

(get-sub-tree id)

Retrieves part of the Bookmarks hierarchy, starting at the specified node.

|id| - The ID of the root of the subtree to retrieve.

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| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-getSubTree.

Retrieves part of the Bookmarks hierarchy, starting at the specified node.

  |id| - The ID of the root of the subtree to retrieve.

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| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-getSubTree.
sourceraw docstring

get-sub-tree*cljs

(get-sub-tree* config id)
source

get-treeclj/smacro

(get-tree)

Retrieves the entire Bookmarks hierarchy.

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| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-getTree.

Retrieves the entire Bookmarks hierarchy.

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| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-getTree.
sourceraw docstring

get-tree*cljs

(get-tree* config)
source

max-sustained-write-operations-per-minute*cljs

(max-sustained-write-operations-per-minute* config)
source

max-write-operations-per-hour*cljs

(max-write-operations-per-hour* config)
source

moveclj/smacro

(move id destination)

Moves the specified BookmarkTreeNode to the provided location.

|id| - https://developer.chrome.com/extensions/bookmarks#property-move-id. |destination| - https://developer.chrome.com/extensions/bookmarks#property-move-destination.

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| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-move.

Moves the specified BookmarkTreeNode to the provided location.

  |id| - https://developer.chrome.com/extensions/bookmarks#property-move-id.
  |destination| - https://developer.chrome.com/extensions/bookmarks#property-move-destination.

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| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-move.
sourceraw docstring

move*cljs

(move* config id destination)
source

on-changed*cljs

(on-changed* config channel & args)
source

on-children-reordered*cljs

(on-children-reordered* config channel & args)
source

on-created*cljs

(on-created* config channel & args)
source

on-import-began*cljs

(on-import-began* config channel & args)
source

on-import-ended*cljs

(on-import-ended* config channel & args)
source

on-moved*cljs

(on-moved* config channel & args)
source

on-removed*cljs

(on-removed* config channel & args)
source

removeclj/smacro

(remove id)

Removes a bookmark or an empty bookmark folder.

|id| - https://developer.chrome.com/extensions/bookmarks#property-remove-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 [].

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/extensions/bookmarks#method-remove.

Removes a bookmark or an empty bookmark folder.

  |id| - https://developer.chrome.com/extensions/bookmarks#property-remove-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 [].

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/extensions/bookmarks#method-remove.
sourceraw docstring

remove*cljs

(remove* config id)
source

remove-treeclj/smacro

(remove-tree id)

Recursively removes a bookmark folder.

|id| - https://developer.chrome.com/extensions/bookmarks#property-removeTree-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 [].

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/extensions/bookmarks#method-removeTree.

Recursively removes a bookmark folder.

  |id| - https://developer.chrome.com/extensions/bookmarks#property-removeTree-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 [].

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/extensions/bookmarks#method-removeTree.
sourceraw docstring

remove-tree*cljs

(remove-tree* config id)
source

(search query)

Searches for BookmarkTreeNodes matching the given query. Queries specified with an object produce BookmarkTreeNodes matching all specified properties.

|query| - Either a string of words and quoted phrases that are matched against bookmark URLs and titles, or an object. If an object, the properties query, url, and title may be specified and bookmarks matching all specified properties will be produced.

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| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-search.

Searches for BookmarkTreeNodes matching the given query. Queries specified with an object produce BookmarkTreeNodes
matching all specified properties.

  |query| - Either a string of words and quoted phrases that are matched against bookmark URLs and titles, or an object.
            If an object, the properties query, url, and title may be specified and bookmarks matching all specified
            properties will be produced.

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| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-search.
sourceraw docstring

search*cljs

(search* config query)
source

tap-all-eventsclj/smacro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.ext.bookmarks namespace.

Taps all valid non-deprecated events in chromex.ext.bookmarks namespace.
sourceraw docstring

tap-on-changed-eventsclj/smacro

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

Fired when a bookmark or folder changes. Note: Currently, only title and url changes trigger this.

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

|id| - https://developer.chrome.com/extensions/bookmarks#property-onChanged-id. |change-info| - https://developer.chrome.com/extensions/bookmarks#property-onChanged-changeInfo.

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

https://developer.chrome.com/extensions/bookmarks#event-onChanged.

Fired when a bookmark or folder changes.  Note: Currently, only title and url changes trigger this.

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

  |id| - https://developer.chrome.com/extensions/bookmarks#property-onChanged-id.
  |change-info| - https://developer.chrome.com/extensions/bookmarks#property-onChanged-changeInfo.

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

https://developer.chrome.com/extensions/bookmarks#event-onChanged.
sourceraw docstring

tap-on-children-reordered-eventsclj/smacro

(tap-on-children-reordered-events channel & args)

Fired when the children of a folder have changed their order due to the order being sorted in the UI. This is not called as a result of a move().

Events will be put on the |channel| with signature [::on-children-reordered [id reorder-info]] where:

|id| - https://developer.chrome.com/extensions/bookmarks#property-onChildrenReordered-id. |reorder-info| - https://developer.chrome.com/extensions/bookmarks#property-onChildrenReordered-reorderInfo.

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

https://developer.chrome.com/extensions/bookmarks#event-onChildrenReordered.

Fired when the children of a folder have changed their order due to the order being sorted in the UI.  This is not called
as a result of a move().

Events will be put on the |channel| with signature [::on-children-reordered [id reorder-info]] where:

  |id| - https://developer.chrome.com/extensions/bookmarks#property-onChildrenReordered-id.
  |reorder-info| - https://developer.chrome.com/extensions/bookmarks#property-onChildrenReordered-reorderInfo.

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

https://developer.chrome.com/extensions/bookmarks#event-onChildrenReordered.
sourceraw docstring

tap-on-created-eventsclj/smacro

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

Fired when a bookmark or folder is created.

Events will be put on the |channel| with signature [::on-created [id bookmark]] where:

|id| - https://developer.chrome.com/extensions/bookmarks#property-onCreated-id. |bookmark| - https://developer.chrome.com/extensions/bookmarks#property-onCreated-bookmark.

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

https://developer.chrome.com/extensions/bookmarks#event-onCreated.

Fired when a bookmark or folder is created.

Events will be put on the |channel| with signature [::on-created [id bookmark]] where:

  |id| - https://developer.chrome.com/extensions/bookmarks#property-onCreated-id.
  |bookmark| - https://developer.chrome.com/extensions/bookmarks#property-onCreated-bookmark.

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

https://developer.chrome.com/extensions/bookmarks#event-onCreated.
sourceraw docstring

tap-on-import-began-eventsclj/smacro

(tap-on-import-began-events channel & args)

Fired when a bookmark import session is begun. Expensive observers should ignore onCreated updates until onImportEnded is fired. Observers should still handle other notifications immediately.

Events will be put on the |channel| with signature [::on-import-began []].

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

https://developer.chrome.com/extensions/bookmarks#event-onImportBegan.

Fired when a bookmark import session is begun.  Expensive observers should ignore onCreated updates until onImportEnded is
fired.  Observers should still handle other notifications immediately.

Events will be put on the |channel| with signature [::on-import-began []].

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

https://developer.chrome.com/extensions/bookmarks#event-onImportBegan.
sourceraw docstring

tap-on-import-ended-eventsclj/smacro

(tap-on-import-ended-events channel & args)

Fired when a bookmark import session is ended.

Events will be put on the |channel| with signature [::on-import-ended []].

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

https://developer.chrome.com/extensions/bookmarks#event-onImportEnded.

Fired when a bookmark import session is ended.

Events will be put on the |channel| with signature [::on-import-ended []].

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

https://developer.chrome.com/extensions/bookmarks#event-onImportEnded.
sourceraw docstring

tap-on-moved-eventsclj/smacro

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

Fired when a bookmark or folder is moved to a different parent folder.

Events will be put on the |channel| with signature [::on-moved [id move-info]] where:

|id| - https://developer.chrome.com/extensions/bookmarks#property-onMoved-id. |move-info| - https://developer.chrome.com/extensions/bookmarks#property-onMoved-moveInfo.

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

https://developer.chrome.com/extensions/bookmarks#event-onMoved.

Fired when a bookmark or folder is moved to a different parent folder.

Events will be put on the |channel| with signature [::on-moved [id move-info]] where:

  |id| - https://developer.chrome.com/extensions/bookmarks#property-onMoved-id.
  |move-info| - https://developer.chrome.com/extensions/bookmarks#property-onMoved-moveInfo.

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

https://developer.chrome.com/extensions/bookmarks#event-onMoved.
sourceraw docstring

tap-on-removed-eventsclj/smacro

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

Fired when a bookmark or folder is removed. When a folder is removed recursively, a single notification is fired for the folder, and none for its contents.

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

|id| - https://developer.chrome.com/extensions/bookmarks#property-onRemoved-id. |remove-info| - https://developer.chrome.com/extensions/bookmarks#property-onRemoved-removeInfo.

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

https://developer.chrome.com/extensions/bookmarks#event-onRemoved.

Fired when a bookmark or folder is removed.  When a folder is removed recursively, a single notification is fired for the
folder, and none for its contents.

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

  |id| - https://developer.chrome.com/extensions/bookmarks#property-onRemoved-id.
  |remove-info| - https://developer.chrome.com/extensions/bookmarks#property-onRemoved-removeInfo.

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

https://developer.chrome.com/extensions/bookmarks#event-onRemoved.
sourceraw docstring

updateclj/smacro

(update id changes)

Updates the properties of a bookmark or folder. Specify only the properties that you want to change; unspecified properties will be left unchanged. Note: Currently, only 'title' and 'url' are supported.

|id| - https://developer.chrome.com/extensions/bookmarks#property-update-id. |changes| - https://developer.chrome.com/extensions/bookmarks#property-update-changes.

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| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-update.

Updates the properties of a bookmark or folder. Specify only the properties that you want to change; unspecified properties
will be left unchanged.  Note: Currently, only 'title' and 'url' are supported.

  |id| - https://developer.chrome.com/extensions/bookmarks#property-update-id.
  |changes| - https://developer.chrome.com/extensions/bookmarks#property-update-changes.

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| - https://developer.chrome.com/extensions/bookmarks#property-callback-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.

https://developer.chrome.com/extensions/bookmarks#method-update.
sourceraw docstring

update*cljs

(update* config id changes)
source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close