chromex.ext.windows — binaryage/chromex 0.9.3

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.

• available since Chrome 36
• https://developer.chrome.com/extensions/windows

api-table clj

create clj/s macro

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

create* cljs

(create* config create-data)

gen-call clj

gen-wrap clj/s macro

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

get clj/s macro

(get window-id)

(get window-id get-info)

Gets details about a window.

|window-id| - https://developer.chrome.com/extensions/windows#property-get-windowId. |get-info| - https://developer.chrome.com/extensions/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/extensions/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/extensions/windows#method-get.

get* cljs

(get* config window-id get-info)

get-all clj/s macro

(get-all)

(get-all get-info)

Gets all windows.

|get-info| - https://developer.chrome.com/extensions/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/extensions/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/extensions/windows#method-getAll.

get-all* cljs

(get-all* config get-info)

get-current clj/s macro

(get-current)

(get-current get-info)

Gets the current window.

|get-info| - https://developer.chrome.com/extensions/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/extensions/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/extensions/windows#method-getCurrent.

get-current* cljs

(get-current* config get-info)

get-last-focused clj/s macro

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

get-last-focused* cljs

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

get-window-id-current clj/s macro

(get-window-id-current)

The windowId value that represents the current window.

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

get-window-id-none clj/s macro

(get-window-id-none)

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

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

on-bounds-changed* cljs

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

on-created* cljs

(on-created* config channel & args)

on-focus-changed* cljs

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

on-removed* cljs

(on-removed* config channel & args)

remove clj/s macro

(remove window-id)

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

|window-id| - https://developer.chrome.com/extensions/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/extensions/windows#method-remove.

remove* cljs

(remove* config window-id)

tap-all-events clj/s macro

(tap-all-events chan)

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

tap-on-bounds-changed-events clj/s macro

(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/extensions/windows#event-onBoundsChanged.

tap-on-created-events clj/s macro

(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/extensions/windows#event-onCreated.

tap-on-focus-changed-events clj/s macro

(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/extensions/windows#event-onFocusChanged.

tap-on-removed-events clj/s macro

(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/extensions/windows#event-onRemoved.

update clj/s macro

(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/extensions/windows#property-update-windowId. |update-info| - https://developer.chrome.com/extensions/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/extensions/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/extensions/windows#method-update.

update* cljs

(update* config window-id update-info)

window-id-current* cljs

(window-id-current* config)

window-id-none* cljs

(window-id-none* config)