Liking cljdoc? Tell your friends :D

chromex.ext.tabs

clj

Use the chrome.tabs API to interact with the browser's tab system. You can use this API to create, modify, and rearrange tabs in the browser.

Use the chrome.tabs API to interact with the browser's tab system. You can use this API to create, modify, and rearrange
tabs in the browser.

  * available since Chrome 34
  * https://developer.chrome.com/extensions/tabs
raw docstring

api-tableclj

source

capture-visible-tabclj/smacro

(capture-visible-tab)
(capture-visible-tab window-id)
(capture-visible-tab window-id options)

Captures the visible area of the currently active tab in the specified window. In order to call this method, the extension must have either the <all_urls> permission or the activeTab permission. In addition to sites that extensions can normally access, this method allows extensions to capture sensitive sites that are otherwise restricted, including chrome:-scheme pages, other extensions' pages, and data: URLs. These sensitive sites can only be captured with the activeTab permission. File URLs may be captured only if the extension has been granted file access.

|window-id| - The target window. Defaults to the current window. |options| - Details about the format and quality of an image.

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

|data-url| - A data URL that encodes an image of the visible area of the captured tab. May be assigned to the 'src' property of an HTML img element for display.

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/tabs#method-captureVisibleTab.

Captures the visible area of the currently active tab in the specified window. In order to call this method, the extension
must have either the &lt;all_urls&gt; permission or the activeTab permission. In addition to sites that extensions can
normally access, this method allows extensions to capture sensitive sites that are otherwise restricted, including
chrome:-scheme pages, other extensions' pages, and data: URLs. These sensitive sites can only be captured with the
activeTab permission. File URLs may be captured only if the extension has been granted file access.

  |window-id| - The target window. Defaults to the current window.
  |options| - Details about the format and quality of an image.

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

  |data-url| - A data URL that encodes an image of the visible area of the captured tab. May be assigned to the 'src'
               property of an HTML img element for display.

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/tabs#method-captureVisibleTab.
sourceraw docstring

capture-visible-tab*cljs

(capture-visible-tab* config window-id options)
source

connectclj/smacro

(connect tab-id)
(connect tab-id connect-info)

Connects to the content script(s) in the specified tab. The 'runtime.onConnect' event is fired in each content script running in the specified tab for the current extension. For more details, see Content Script Messaging.

|tab-id| - https://developer.chrome.com/extensions/tabs#property-connect-tabId. |connect-info| - https://developer.chrome.com/extensions/tabs#property-connect-connectInfo.

https://developer.chrome.com/extensions/tabs#method-connect.

Connects to the content script(s) in the specified tab. The 'runtime.onConnect' event is fired in each content script
running in the specified tab for the current extension. For more details, see Content Script Messaging.

  |tab-id| - https://developer.chrome.com/extensions/tabs#property-connect-tabId.
  |connect-info| - https://developer.chrome.com/extensions/tabs#property-connect-connectInfo.

https://developer.chrome.com/extensions/tabs#method-connect.
sourceraw docstring

connect*cljs

(connect* config tab-id connect-info)
source

createclj/smacro

(create create-properties)

Creates a new tab.

|create-properties| - https://developer.chrome.com/extensions/tabs#property-create-createProperties.

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

|tab| - The created tab.

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/tabs#method-create.

Creates a new tab.

  |create-properties| - https://developer.chrome.com/extensions/tabs#property-create-createProperties.

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

  |tab| - The created tab.

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/tabs#method-create.
sourceraw docstring

create*cljs

(create* config create-properties)
source

detect-languageclj/smacro

(detect-language)
(detect-language tab-id)

Detects the primary language of the content in a tab.

|tab-id| - Defaults to the active tab of the current window.

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

|language| - An ISO language code such as en or fr. For a complete list of languages supported by this method, see kLanguageInfoTable. The second to fourth columns are checked and the first non-NULL value is returned, except for Simplified Chinese for which zh-CN is returned. For an unknown/undefined language, und is returned.

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/tabs#method-detectLanguage.

Detects the primary language of the content in a tab.

  |tab-id| - Defaults to the active tab of the current window.

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

  |language| - An ISO language code such as en or fr. For a complete list of languages supported by this method, see
               kLanguageInfoTable. The second to fourth columns are checked and the first non-NULL value is returned,
               except for Simplified Chinese for which zh-CN is returned. For an unknown/undefined language, und is
               returned.

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/tabs#method-detectLanguage.
sourceraw docstring

detect-language*cljs

(detect-language* config tab-id)
source

discardclj/smacro

(discard)
(discard tab-id)

Discards a tab from memory. Discarded tabs are still visible on the tab strip and are reloaded when activated.

|tab-id| - The ID of the tab to be discarded. If specified, the tab is discarded unless it is active or already discarded. If omitted, the browser discards the least important tab. This can fail if no discardable tabs exist.

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

|tab| - The discarded tab, if it was successfully discarded; undefined otherwise.

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/tabs#method-discard.

Discards a tab from memory. Discarded tabs are still visible on the tab strip and are reloaded when activated.

  |tab-id| - The ID of the tab to be discarded. If specified, the tab is discarded unless it is active or already
             discarded. If omitted, the browser discards the least important tab. This can fail if no discardable tabs
             exist.

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

  |tab| - The discarded tab, if it was successfully discarded; undefined otherwise.

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/tabs#method-discard.
sourceraw docstring

discard*cljs

(discard* config tab-id)
source

duplicateclj/smacro

(duplicate tab-id)

Duplicates a tab.

|tab-id| - The ID of the tab to duplicate.

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

|tab| - Details about the duplicated tab. The 'tabs.Tab' object does not contain url, pendingUrl, title, and favIconUrl if the 'tabs' permission has not been requested.

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/tabs#method-duplicate.

Duplicates a tab.

  |tab-id| - The ID of the tab to duplicate.

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

  |tab| - Details about the duplicated tab. The 'tabs.Tab' object does not contain url, pendingUrl, title, and favIconUrl
          if the 'tabs' permission has not been requested.

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/tabs#method-duplicate.
sourceraw docstring

duplicate*cljs

(duplicate* config tab-id)
source

execute-scriptclj/smacro

(execute-script tab-id details)

Injects JavaScript code into a page. For details, see the programmatic injection section of the content scripts doc.

|tab-id| - The ID of the tab in which to run the script; defaults to the active tab of the current window. |details| - Details of the script to run. Either the code or the file property must be set, but both may not be set at the same time.

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| - The result of the script in every injected frame.

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/tabs#method-executeScript.

Injects JavaScript code into a page. For details, see the programmatic injection section of the content scripts doc.

  |tab-id| - The ID of the tab in which to run the script; defaults to the active tab of the current window.
  |details| - Details of the script to run. Either the code or the file property must be set, but both may not be set at
              the same time.

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| - The result of the script in every injected frame.

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/tabs#method-executeScript.
sourceraw docstring

execute-script*cljs

(execute-script* config tab-id details)
source

gen-callclj

source

gen-wrapclj/smacro

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

getclj/smacro

(get tab-id)

Retrieves details about the specified tab.

|tab-id| - https://developer.chrome.com/extensions/tabs#property-get-tabId.

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

|tab| - https://developer.chrome.com/extensions/tabs#property-callback-tab.

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/tabs#method-get.

Retrieves details about the specified tab.

  |tab-id| - https://developer.chrome.com/extensions/tabs#property-get-tabId.

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

  |tab| - https://developer.chrome.com/extensions/tabs#property-callback-tab.

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/tabs#method-get.
sourceraw docstring

get*cljs

(get* config tab-id)
source

get-all-in-windowclj/smacro

(get-all-in-window)
(get-all-in-window window-id)

Gets details about all tabs in the specified window.

|window-id| - Defaults to the current window.

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

|tabs| - https://developer.chrome.com/extensions/tabs#property-callback-tabs.

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/tabs#method-getAllInWindow.

Gets details about all tabs in the specified window.

  |window-id| - Defaults to the current window.

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

  |tabs| - https://developer.chrome.com/extensions/tabs#property-callback-tabs.

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/tabs#method-getAllInWindow.
sourceraw docstring

get-all-in-window*cljs

(get-all-in-window* config window-id)
source

get-currentclj/smacro

(get-current)

Gets the tab that this script call is being made from. May be undefined if called from a non-tab context (for example, a background page or popup view).

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

|tab| - https://developer.chrome.com/extensions/tabs#property-callback-tab.

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/tabs#method-getCurrent.

Gets the tab that this script call is being made from. May be undefined if called from a non-tab context (for example, a
background page or popup view).

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

  |tab| - https://developer.chrome.com/extensions/tabs#property-callback-tab.

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/tabs#method-getCurrent.
sourceraw docstring

get-current*cljs

(get-current* config)
source

get-selectedclj/smacro

(get-selected)
(get-selected window-id)

Gets the tab that is selected in the specified window.

|window-id| - Defaults to the current window.

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

|tab| - https://developer.chrome.com/extensions/tabs#property-callback-tab.

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/tabs#method-getSelected.

Gets the tab that is selected in the specified window.

  |window-id| - Defaults to the current window.

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

  |tab| - https://developer.chrome.com/extensions/tabs#property-callback-tab.

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/tabs#method-getSelected.
sourceraw docstring

get-selected*cljs

(get-selected* config window-id)
source

get-tab-id-noneclj/smacro

(get-tab-id-none)

An ID that represents the absence of a browser tab.

https://developer.chrome.com/extensions/tabs#property-TAB_ID_NONE.

An ID that represents the absence of a browser tab.

https://developer.chrome.com/extensions/tabs#property-TAB_ID_NONE.
sourceraw docstring

get-zoomclj/smacro

(get-zoom)
(get-zoom tab-id)

Gets the current zoom factor of a specified tab.

|tab-id| - The ID of the tab to get the current zoom factor from; defaults to the active tab of the current window.

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

|zoom-factor| - The tab's current zoom factor.

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/tabs#method-getZoom.

Gets the current zoom factor of a specified tab.

  |tab-id| - The ID of the tab to get the current zoom factor from; defaults to the active tab of the current window.

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

  |zoom-factor| - The tab's current zoom factor.

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/tabs#method-getZoom.
sourceraw docstring

get-zoom*cljs

(get-zoom* config tab-id)
source

get-zoom-settingsclj/smacro

(get-zoom-settings)
(get-zoom-settings tab-id)

Gets the current zoom settings of a specified tab.

|tab-id| - The ID of the tab to get the current zoom settings from; defaults to the active tab of the current window.

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

|zoom-settings| - The tab's current zoom settings.

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/tabs#method-getZoomSettings.

Gets the current zoom settings of a specified tab.

  |tab-id| - The ID of the tab to get the current zoom settings from; defaults to the active tab of the current window.

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

  |zoom-settings| - The tab's current zoom settings.

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/tabs#method-getZoomSettings.
sourceraw docstring

get-zoom-settings*cljs

(get-zoom-settings* config tab-id)
source

go-backclj/smacro

(go-back)
(go-back tab-id)

Go back to the previous page, if one is available.

|tab-id| - The ID of the tab to navigate back; defaults to the selected tab of the current window.

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/tabs#method-goBack.

Go back to the previous page, if one is available.

  |tab-id| - The ID of the tab to navigate back; defaults to the selected tab of the current window.

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/tabs#method-goBack.
sourceraw docstring

go-back*cljs

(go-back* config tab-id)
source

go-forwardclj/smacro

(go-forward)
(go-forward tab-id)

Go foward to the next page, if one is available.

|tab-id| - The ID of the tab to navigate forward; defaults to the selected tab of the current window.

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/tabs#method-goForward.

Go foward to the next page, if one is available.

  |tab-id| - The ID of the tab to navigate forward; defaults to the selected tab of the current window.

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/tabs#method-goForward.
sourceraw docstring

go-forward*cljs

(go-forward* config tab-id)
source

highlightclj/smacro

(highlight highlight-info)

Highlights the given tabs and focuses on the first of group. Will appear to do nothing if the specified tab is currently active.

|highlight-info| - https://developer.chrome.com/extensions/tabs#property-highlight-highlightInfo.

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

|window| - Contains details about the window whose tabs were highlighted.

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/tabs#method-highlight.

Highlights the given tabs and focuses on the first of group. Will appear to do nothing if the specified tab is currently
active.

  |highlight-info| - https://developer.chrome.com/extensions/tabs#property-highlight-highlightInfo.

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

  |window| - Contains details about the window whose tabs were highlighted.

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/tabs#method-highlight.
sourceraw docstring

highlight*cljs

(highlight* config highlight-info)
source

insert-cssclj/smacro

(insert-css tab-id details)

Injects CSS into a page. For details, see the programmatic injection section of the content scripts doc.

|tab-id| - The ID of the tab in which to insert the CSS; defaults to the active tab of the current window. |details| - Details of the CSS text to insert. Either the code or the file property must be set, but both may not be set at the same time.

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/tabs#method-insertCSS.

Injects CSS into a page. For details, see the programmatic injection section of the content scripts doc.

  |tab-id| - The ID of the tab in which to insert the CSS; defaults to the active tab of the current window.
  |details| - Details of the CSS text to insert. Either the code or the file property must be set, but both may not be
              set at the same time.

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/tabs#method-insertCSS.
sourceraw docstring

insert-css*cljs

(insert-css* config tab-id details)
source

moveclj/smacro

(move tab-ids move-properties)

Moves one or more tabs to a new position within its window, or to a new window. Note that tabs can only be moved to and from normal (window.type === 'normal') windows.

|tab-ids| - The tab ID or list of tab IDs to move. |move-properties| - https://developer.chrome.com/extensions/tabs#property-move-moveProperties.

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

|tabs| - Details about the moved tabs.

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/tabs#method-move.

Moves one or more tabs to a new position within its window, or to a new window. Note that tabs can only be moved to and
from normal (window.type === 'normal') windows.

  |tab-ids| - The tab ID or list of tab IDs to move.
  |move-properties| - https://developer.chrome.com/extensions/tabs#property-move-moveProperties.

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

  |tabs| - Details about the moved tabs.

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/tabs#method-move.
sourceraw docstring

move*cljs

(move* config tab-ids move-properties)
source

on-activated*cljs

(on-activated* config channel & args)
source

on-active-changed*cljs

(on-active-changed* config channel & args)
source

on-attached*cljs

(on-attached* config channel & args)
source

on-created*cljs

(on-created* config channel & args)
source

on-detached*cljs

(on-detached* config channel & args)
source

on-highlight-changed*cljs

(on-highlight-changed* config channel & args)
source

on-highlighted*cljs

(on-highlighted* config channel & args)
source

on-moved*cljs

(on-moved* config channel & args)
source

on-removed*cljs

(on-removed* config channel & args)
source

on-replaced*cljs

(on-replaced* config channel & args)
source

on-selection-changed*cljs

(on-selection-changed* config channel & args)
source

on-updated*cljs

(on-updated* config channel & args)
source

on-zoom-change*cljs

(on-zoom-change* config channel & args)
source

queryclj/smacro

(query query-info)

Gets all tabs that have the specified properties, or all tabs if no properties are specified.

|query-info| - https://developer.chrome.com/extensions/tabs#property-query-queryInfo.

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/tabs#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/tabs#method-query.

Gets all tabs that have the specified properties, or all tabs if no properties are specified.

  |query-info| - https://developer.chrome.com/extensions/tabs#property-query-queryInfo.

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/tabs#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/tabs#method-query.
sourceraw docstring

query*cljs

(query* config query-info)
source

reloadclj/smacro

(reload)
(reload tab-id)
(reload tab-id reload-properties)

Reload a tab.

|tab-id| - The ID of the tab to reload; defaults to the selected tab of the current window. |reload-properties| - https://developer.chrome.com/extensions/tabs#property-reload-reloadProperties.

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/tabs#method-reload.

Reload a tab.

  |tab-id| - The ID of the tab to reload; defaults to the selected tab of the current window.
  |reload-properties| - https://developer.chrome.com/extensions/tabs#property-reload-reloadProperties.

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/tabs#method-reload.
sourceraw docstring

reload*cljs

(reload* config tab-id reload-properties)
source

removeclj/smacro

(remove tab-ids)

Closes one or more tabs.

|tab-ids| - The tab ID or list of tab IDs to close.

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

Closes one or more tabs.

  |tab-ids| - The tab ID or list of tab IDs to close.

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

remove*cljs

(remove* config tab-ids)
source

send-messageclj/smacro

(send-message tab-id message)
(send-message tab-id message options)

Sends a single message to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The 'runtime.onMessage' event is fired in each content script running in the specified tab for the current extension.

|tab-id| - https://developer.chrome.com/extensions/tabs#property-sendMessage-tabId. |message| - The message to send. This message should be a JSON-ifiable object. |options| - https://developer.chrome.com/extensions/tabs#property-sendMessage-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 [response] where:

|response| - The JSON response object sent by the handler of the message. If an error occurs while connecting to the specified tab, the callback is called with no arguments and 'runtime.lastError' is set to the error message.

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/tabs#method-sendMessage.

Sends a single message to the content script(s) in the specified tab, with an optional callback to run when a response is
sent back.  The 'runtime.onMessage' event is fired in each content script running in the specified tab for the current
extension.

  |tab-id| - https://developer.chrome.com/extensions/tabs#property-sendMessage-tabId.
  |message| - The message to send. This message should be a JSON-ifiable object.
  |options| - https://developer.chrome.com/extensions/tabs#property-sendMessage-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 [response] where:

  |response| - The JSON response object sent by the handler of the message. If an error occurs while connecting to the
               specified tab, the callback is called with no arguments and 'runtime.lastError' is set to the error message.

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/tabs#method-sendMessage.
sourceraw docstring

send-message*cljs

(send-message* config tab-id message options)
source

send-requestclj/smacro

(send-request tab-id request)

Sends a single request to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The 'extension.onRequest' event is fired in each content script running in the specified tab for the current extension.

|tab-id| - https://developer.chrome.com/extensions/tabs#property-sendRequest-tabId. |request| - https://developer.chrome.com/extensions/tabs#property-sendRequest-request.

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

|response| - The JSON response object sent by the handler of the request. If an error occurs while connecting to the specified tab, the callback is called with no arguments and 'runtime.lastError' is set to the error message.

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/tabs#method-sendRequest.

Sends a single request to the content script(s) in the specified tab, with an optional callback to run when a response is
sent back.  The 'extension.onRequest' event is fired in each content script running in the specified tab for the current
extension.

  |tab-id| - https://developer.chrome.com/extensions/tabs#property-sendRequest-tabId.
  |request| - https://developer.chrome.com/extensions/tabs#property-sendRequest-request.

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

  |response| - The JSON response object sent by the handler of the request. If an error occurs while connecting to the
               specified tab, the callback is called with no arguments and 'runtime.lastError' is set to the error message.

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/tabs#method-sendRequest.
sourceraw docstring

send-request*cljs

(send-request* config tab-id request)
source

set-zoomclj/smacro

(set-zoom tab-id zoom-factor)

Zooms a specified tab.

|tab-id| - The ID of the tab to zoom; defaults to the active tab of the current window. |zoom-factor| - The new zoom factor. A value of 0 sets the tab to its current default zoom factor. Values greater than 0 specify a (possibly non-default) zoom factor for the tab.

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/tabs#method-setZoom.

Zooms a specified tab.

  |tab-id| - The ID of the tab to zoom; defaults to the active tab of the current window.
  |zoom-factor| - The new zoom factor. A value of 0 sets the tab to its current default zoom factor. Values greater than
                  0 specify a (possibly non-default) zoom factor for the tab.

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/tabs#method-setZoom.
sourceraw docstring

set-zoom*cljs

(set-zoom* config tab-id zoom-factor)
source

set-zoom-settingsclj/smacro

(set-zoom-settings tab-id zoom-settings)

Sets the zoom settings for a specified tab, which define how zoom changes are handled. These settings are reset to defaults upon navigating the tab.

|tab-id| - The ID of the tab to change the zoom settings for; defaults to the active tab of the current window. |zoom-settings| - Defines how zoom changes are handled and at what scope.

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/tabs#method-setZoomSettings.

Sets the zoom settings for a specified tab, which define how zoom changes are handled. These settings are reset to defaults
upon navigating the tab.

  |tab-id| - The ID of the tab to change the zoom settings for; defaults to the active tab of the current window.
  |zoom-settings| - Defines how zoom changes are handled and at what scope.

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/tabs#method-setZoomSettings.
sourceraw docstring

set-zoom-settings*cljs

(set-zoom-settings* config tab-id zoom-settings)
source

tab-id-none*cljs

(tab-id-none* config)
source

tap-all-eventsclj/smacro

(tap-all-events chan)

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

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

tap-on-activated-eventsclj/smacro

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

Fires when the active tab in a window changes. Note that the tab's URL may not be set at the time this event fired, but you can listen to onUpdated events so as to be notified when a URL is set.

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

|active-info| - https://developer.chrome.com/extensions/tabs#property-onActivated-activeInfo.

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

https://developer.chrome.com/extensions/tabs#event-onActivated.

Fires when the active tab in a window changes. Note that the tab's URL may not be set at the time this event fired, but you
can listen to onUpdated events so as to be notified when a URL is set.

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

  |active-info| - https://developer.chrome.com/extensions/tabs#property-onActivated-activeInfo.

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

https://developer.chrome.com/extensions/tabs#event-onActivated.
sourceraw docstring

tap-on-active-changed-eventsclj/smacro

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

Fires when the selected tab in a window changes. Note that the tab's URL may not be set at the time this event fired, but you can listen to 'tabs.onUpdated' events so as to be notified when a URL is set.

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

|tab-id| - The ID of the tab that has become active. |select-info| - https://developer.chrome.com/extensions/tabs#property-onActiveChanged-selectInfo.

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

https://developer.chrome.com/extensions/tabs#event-onActiveChanged.

Fires when the selected tab in a window changes. Note that the tab's URL may not be set at the time this event fired, but
you can listen to 'tabs.onUpdated' events so as to be notified when a URL is set.

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

  |tab-id| - The ID of the tab that has become active.
  |select-info| - https://developer.chrome.com/extensions/tabs#property-onActiveChanged-selectInfo.

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

https://developer.chrome.com/extensions/tabs#event-onActiveChanged.
sourceraw docstring

tap-on-attached-eventsclj/smacro

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

Fired when a tab is attached to a window; for example, because it was moved between windows.

Events will be put on the |channel| with signature [::on-attached [tab-id attach-info]] where:

|tab-id| - https://developer.chrome.com/extensions/tabs#property-onAttached-tabId. |attach-info| - https://developer.chrome.com/extensions/tabs#property-onAttached-attachInfo.

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

https://developer.chrome.com/extensions/tabs#event-onAttached.

Fired when a tab is attached to a window; for example, because it was moved between windows.

Events will be put on the |channel| with signature [::on-attached [tab-id attach-info]] where:

  |tab-id| - https://developer.chrome.com/extensions/tabs#property-onAttached-tabId.
  |attach-info| - https://developer.chrome.com/extensions/tabs#property-onAttached-attachInfo.

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

https://developer.chrome.com/extensions/tabs#event-onAttached.
sourceraw docstring

tap-on-created-eventsclj/smacro

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

Fired when a tab is created. Note that the tab's URL may not be set at the time this event is fired, but you can listen to onUpdated events so as to be notified when a URL is set.

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

|tab| - Details of the tab that was created.

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

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

Fired when a tab is created. Note that the tab's URL may not be set at the time this event is fired, but you can listen to
onUpdated events so as to be notified when a URL is set.

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

  |tab| - Details of the tab that was created.

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

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

tap-on-detached-eventsclj/smacro

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

Fired when a tab is detached from a window; for example, because it was moved between windows.

Events will be put on the |channel| with signature [::on-detached [tab-id detach-info]] where:

|tab-id| - https://developer.chrome.com/extensions/tabs#property-onDetached-tabId. |detach-info| - https://developer.chrome.com/extensions/tabs#property-onDetached-detachInfo.

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

https://developer.chrome.com/extensions/tabs#event-onDetached.

Fired when a tab is detached from a window; for example, because it was moved between windows.

Events will be put on the |channel| with signature [::on-detached [tab-id detach-info]] where:

  |tab-id| - https://developer.chrome.com/extensions/tabs#property-onDetached-tabId.
  |detach-info| - https://developer.chrome.com/extensions/tabs#property-onDetached-detachInfo.

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

https://developer.chrome.com/extensions/tabs#event-onDetached.
sourceraw docstring

tap-on-highlight-changed-eventsclj/smacro

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

Fired when the highlighted or selected tabs in a window changes.

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

|select-info| - https://developer.chrome.com/extensions/tabs#property-onHighlightChanged-selectInfo.

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

https://developer.chrome.com/extensions/tabs#event-onHighlightChanged.

Fired when the highlighted or selected tabs in a window changes.

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

  |select-info| - https://developer.chrome.com/extensions/tabs#property-onHighlightChanged-selectInfo.

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

https://developer.chrome.com/extensions/tabs#event-onHighlightChanged.
sourceraw docstring

tap-on-highlighted-eventsclj/smacro

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

Fired when the highlighted or selected tabs in a window changes.

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

|highlight-info| - https://developer.chrome.com/extensions/tabs#property-onHighlighted-highlightInfo.

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

https://developer.chrome.com/extensions/tabs#event-onHighlighted.

Fired when the highlighted or selected tabs in a window changes.

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

  |highlight-info| - https://developer.chrome.com/extensions/tabs#property-onHighlighted-highlightInfo.

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

https://developer.chrome.com/extensions/tabs#event-onHighlighted.
sourceraw docstring

tap-on-moved-eventsclj/smacro

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

Fired when a tab is moved within a window. Only one move event is fired, representing the tab the user directly moved. Move events are not fired for the other tabs that must move in response to the manually-moved tab. This event is not fired when a tab is moved between windows; for details, see 'tabs.onDetached'.

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

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

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

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

Fired when a tab is moved within a window. Only one move event is fired, representing the tab the user directly moved. Move
events are not fired for the other tabs that must move in response to the manually-moved tab. This event is not fired when
a tab is moved between windows; for details, see 'tabs.onDetached'.

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

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

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

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

tap-on-removed-eventsclj/smacro

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

Fired when a tab is closed.

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

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

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

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

Fired when a tab is closed.

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

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

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

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

tap-on-replaced-eventsclj/smacro

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

Fired when a tab is replaced with another tab due to prerendering or instant.

Events will be put on the |channel| with signature [::on-replaced [added-tab-id removed-tab-id]] where:

|added-tab-id| - https://developer.chrome.com/extensions/tabs#property-onReplaced-addedTabId. |removed-tab-id| - https://developer.chrome.com/extensions/tabs#property-onReplaced-removedTabId.

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

https://developer.chrome.com/extensions/tabs#event-onReplaced.

Fired when a tab is replaced with another tab due to prerendering or instant.

Events will be put on the |channel| with signature [::on-replaced [added-tab-id removed-tab-id]] where:

  |added-tab-id| - https://developer.chrome.com/extensions/tabs#property-onReplaced-addedTabId.
  |removed-tab-id| - https://developer.chrome.com/extensions/tabs#property-onReplaced-removedTabId.

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

https://developer.chrome.com/extensions/tabs#event-onReplaced.
sourceraw docstring

tap-on-selection-changed-eventsclj/smacro

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

Fires when the selected tab in a window changes.

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

|tab-id| - The ID of the tab that has become active. |select-info| - https://developer.chrome.com/extensions/tabs#property-onSelectionChanged-selectInfo.

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

https://developer.chrome.com/extensions/tabs#event-onSelectionChanged.

Fires when the selected tab in a window changes.

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

  |tab-id| - The ID of the tab that has become active.
  |select-info| - https://developer.chrome.com/extensions/tabs#property-onSelectionChanged-selectInfo.

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

https://developer.chrome.com/extensions/tabs#event-onSelectionChanged.
sourceraw docstring

tap-on-updated-eventsclj/smacro

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

Fired when a tab is updated.

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

|tab-id| - https://developer.chrome.com/extensions/tabs#property-onUpdated-tabId. |change-info| - Lists the changes to the state of the tab that was updated. |tab| - Gives the state of the tab that was updated.

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

https://developer.chrome.com/extensions/tabs#event-onUpdated.

Fired when a tab is updated.

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

  |tab-id| - https://developer.chrome.com/extensions/tabs#property-onUpdated-tabId.
  |change-info| - Lists the changes to the state of the tab that was updated.
  |tab| - Gives the state of the tab that was updated.

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

https://developer.chrome.com/extensions/tabs#event-onUpdated.
sourceraw docstring

tap-on-zoom-change-eventsclj/smacro

(tap-on-zoom-change-events channel & args)

Fired when a tab is zoomed.

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

|zoom-change-info| - https://developer.chrome.com/extensions/tabs#property-onZoomChange-ZoomChangeInfo.

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

https://developer.chrome.com/extensions/tabs#event-onZoomChange.

Fired when a tab is zoomed.

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

  |zoom-change-info| - https://developer.chrome.com/extensions/tabs#property-onZoomChange-ZoomChangeInfo.

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

https://developer.chrome.com/extensions/tabs#event-onZoomChange.
sourceraw docstring

updateclj/smacro

(update tab-id update-properties)

Modifies the properties of a tab. Properties that are not specified in updateProperties are not modified.

|tab-id| - Defaults to the selected tab of the current window. |update-properties| - https://developer.chrome.com/extensions/tabs#property-update-updateProperties.

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

|tab| - Details about the updated tab. The 'tabs.Tab' object does not contain url, pendingUrl, title, and favIconUrl if the 'tabs' permission has not been requested.

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/tabs#method-update.

Modifies the properties of a tab. Properties that are not specified in updateProperties are not modified.

  |tab-id| - Defaults to the selected tab of the current window.
  |update-properties| - https://developer.chrome.com/extensions/tabs#property-update-updateProperties.

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

  |tab| - Details about the updated tab. The 'tabs.Tab' object does not contain url, pendingUrl, title, and favIconUrl if
          the 'tabs' permission has not been requested.

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/tabs#method-update.
sourceraw docstring

update*cljs

(update* config tab-id update-properties)
source

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

× close