Liking cljdoc? Tell your friends :D

chromex.app.windows

clj

Use the chrome.windows API to interact with browser windows. You can use this API to create, modify, and rearrange windows in the browser.

Use the chrome.windows API to interact with browser windows. You can use this API to create, modify, and rearrange windows
in the browser.

  * available since Chrome 36
  * https://developer.chrome.com/apps/windows
raw docstring

api-tableclj

source

createclj/smacro

(create)
(create create-data)

Creates (opens) a new browser window with any optional sizing, position, or default URL provided.

|create-data| - https://developer.chrome.com/apps/windows#property-create-createData.

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 created window.

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

Creates (opens) a new browser window with any optional sizing, position, or default URL provided.

  |create-data| - https://developer.chrome.com/apps/windows#property-create-createData.

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 created window.

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

create*cljs

(create* config create-data)
source

gen-callclj

source

gen-wrapclj/smacro

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

getclj/smacro

(get window-id)
(get window-id get-info)

Gets details about a window.

|window-id| - https://developer.chrome.com/apps/windows#property-get-windowId. |get-info| - https://developer.chrome.com/apps/windows#property-get-getInfo.

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| - https://developer.chrome.com/apps/windows#property-callback-window.

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

Gets details about a window.

  |window-id| - https://developer.chrome.com/apps/windows#property-get-windowId.
  |get-info| - https://developer.chrome.com/apps/windows#property-get-getInfo.

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| - https://developer.chrome.com/apps/windows#property-callback-window.

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

get*cljs

(get* config window-id get-info)
source

get-allclj/smacro

(get-all)
(get-all get-info)

Gets all windows.

|get-info| - https://developer.chrome.com/apps/windows#property-getAll-getInfo.

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

|windows| - https://developer.chrome.com/apps/windows#property-callback-windows.

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/apps/windows#method-getAll.

Gets all windows.

  |get-info| - https://developer.chrome.com/apps/windows#property-getAll-getInfo.

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

  |windows| - https://developer.chrome.com/apps/windows#property-callback-windows.

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/apps/windows#method-getAll.
sourceraw docstring

get-all*cljs

(get-all* config get-info)
source

get-currentclj/smacro

(get-current)
(get-current get-info)

Gets the current window.

|get-info| - https://developer.chrome.com/apps/windows#property-getCurrent-getInfo.

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| - https://developer.chrome.com/apps/windows#property-callback-window.

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

Gets the current window.

  |get-info| - https://developer.chrome.com/apps/windows#property-getCurrent-getInfo.

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| - https://developer.chrome.com/apps/windows#property-callback-window.

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

get-current*cljs

(get-current* config get-info)
source

get-last-focusedclj/smacro

(get-last-focused)
(get-last-focused get-info)

Gets the window that was most recently focused — typically the window 'on top'.

|get-info| - https://developer.chrome.com/apps/windows#property-getLastFocused-getInfo.

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| - https://developer.chrome.com/apps/windows#property-callback-window.

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/apps/windows#method-getLastFocused.

Gets the window that was most recently focused — typically the window 'on top'.

  |get-info| - https://developer.chrome.com/apps/windows#property-getLastFocused-getInfo.

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| - https://developer.chrome.com/apps/windows#property-callback-window.

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/apps/windows#method-getLastFocused.
sourceraw docstring

get-last-focused*cljs

(get-last-focused* config get-info)
source

get-window-id-currentclj/smacro

(get-window-id-current)

The windowId value that represents the current window.

https://developer.chrome.com/apps/windows#property-WINDOW_ID_CURRENT.

The windowId value that represents the current window.

https://developer.chrome.com/apps/windows#property-WINDOW_ID_CURRENT.
sourceraw docstring

get-window-id-noneclj/smacro

(get-window-id-none)

The windowId value that represents the absence of a chrome browser window.

https://developer.chrome.com/apps/windows#property-WINDOW_ID_NONE.

The windowId value that represents the absence of a chrome browser window.

https://developer.chrome.com/apps/windows#property-WINDOW_ID_NONE.
sourceraw docstring

on-bounds-changed*cljs

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

on-created*cljs

(on-created* config channel & args)
source

on-focus-changed*cljs

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

on-removed*cljs

(on-removed* config channel & args)
source

removeclj/smacro

(remove window-id)

Removes (closes) a window and all the tabs inside it.

|window-id| - https://developer.chrome.com/apps/windows#property-remove-windowId.

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

Removes (closes) a window and all the tabs inside it.

  |window-id| - https://developer.chrome.com/apps/windows#property-remove-windowId.

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

remove*cljs

(remove* config window-id)
source

tap-all-eventsclj/smacro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.app.windows namespace.

Taps all valid non-deprecated events in chromex.app.windows namespace.
sourceraw docstring

tap-on-bounds-changed-eventsclj/smacro

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

Fired when a window has been resized; this event is only dispatched when the new bounds are committed, and not for in-progress changes.

Events will be put on the |channel| with signature [::on-bounds-changed [window]] where:

|window| - Details of the window. The tabs will not be populated for the window.

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

https://developer.chrome.com/apps/windows#event-onBoundsChanged.

Fired when a window has been resized; this event is only dispatched when the new bounds are committed, and not for
in-progress changes.

Events will be put on the |channel| with signature [::on-bounds-changed [window]] where:

  |window| - Details of the window. The tabs will not be populated for the window.

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

https://developer.chrome.com/apps/windows#event-onBoundsChanged.
sourceraw docstring

tap-on-created-eventsclj/smacro

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

Fired when a window is created.

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

|window| - Details of the created window.

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

https://developer.chrome.com/apps/windows#event-onCreated.

Fired when a window is created.

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

  |window| - Details of the created window.

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

https://developer.chrome.com/apps/windows#event-onCreated.
sourceraw docstring

tap-on-focus-changed-eventsclj/smacro

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

Fired when the currently focused window changes. Returns chrome.windows.WINDOW_ID_NONE if all Chrome windows have lost focus. Note: On some Linux window managers, WINDOW_ID_NONE is always sent immediately preceding a switch from one Chrome window to another.

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

|window-id| - ID of the newly-focused window.

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

https://developer.chrome.com/apps/windows#event-onFocusChanged.

Fired when the currently focused window changes. Returns chrome.windows.WINDOW_ID_NONE if all Chrome windows have lost
focus. Note: On some Linux window managers, WINDOW_ID_NONE is always sent immediately preceding a switch from one Chrome
window to another.

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

  |window-id| - ID of the newly-focused window.

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

https://developer.chrome.com/apps/windows#event-onFocusChanged.
sourceraw docstring

tap-on-removed-eventsclj/smacro

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

Fired when a window is removed (closed).

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

|window-id| - ID of the removed window.

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

https://developer.chrome.com/apps/windows#event-onRemoved.

Fired when a window is removed (closed).

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

  |window-id| - ID of the removed window.

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

https://developer.chrome.com/apps/windows#event-onRemoved.
sourceraw docstring

updateclj/smacro

(update window-id update-info)

Updates the properties of a window. Specify only the properties that to be changed; unspecified properties are unchanged.

|window-id| - https://developer.chrome.com/apps/windows#property-update-windowId. |update-info| - https://developer.chrome.com/apps/windows#property-update-updateInfo.

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| - https://developer.chrome.com/apps/windows#property-callback-window.

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

Updates the properties of a window. Specify only the properties that to be changed; unspecified properties are unchanged.

  |window-id| - https://developer.chrome.com/apps/windows#property-update-windowId.
  |update-info| - https://developer.chrome.com/apps/windows#property-update-updateInfo.

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| - https://developer.chrome.com/apps/windows#property-callback-window.

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

update*cljs

(update* config window-id update-info)
source

window-id-current*cljs

(window-id-current* config)
source

window-id-none*cljs

(window-id-none* config)
source

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

× close