chromex.ext.web-navigation — binaryage/chromex 0.9.3

clj

Use the chrome.webNavigation API to receive notifications about the status of navigation requests in-flight.

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

api-table clj

gen-call clj

gen-wrap clj/s macro

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

get-all-frames clj/s macro

(get-all-frames details)

Retrieves information about all frames of a given tab.

|details| - Information about the tab to retrieve all frames from.

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

|details| - A list of frames in the given tab, null if the specified tab ID is invalid.

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/webNavigation#method-getAllFrames.

get-all-frames* cljs

(get-all-frames* config details)

get-frame clj/s macro

(get-frame details)

Retrieves information about the given frame. A frame refers to an <iframe> or a <frame> of a web page and is identified by a tab ID and a frame ID.

|details| - Information about the frame to retrieve information about.

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

|details| - Information about the requested frame, null if the specified frame ID and/or tab ID are invalid.

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/webNavigation#method-getFrame.

get-frame* cljs

(get-frame* config details)

on-before-navigate* cljs

(on-before-navigate* config channel & args)

on-committed* cljs

(on-committed* config channel & args)

on-completed* cljs

(on-completed* config channel & args)

on-created-navigation-target* cljs

(on-created-navigation-target* config channel & args)

on-dom-content-loaded* cljs

(on-dom-content-loaded* config channel & args)

on-error-occurred* cljs

(on-error-occurred* config channel & args)

on-history-state-updated* cljs

(on-history-state-updated* config channel & args)

on-reference-fragment-updated* cljs

(on-reference-fragment-updated* config channel & args)

on-tab-replaced* cljs

(on-tab-replaced* config channel & args)

tap-all-events clj/s macro

(tap-all-events chan)

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

tap-on-before-navigate-events clj/s macro

(tap-on-before-navigate-events channel & args)

Fired when a navigation is about to occur.

Events will be put on the |channel| with signature [::on-before-navigate [details]] where:

|details| - https://developer.chrome.com/extensions/webNavigation#property-onBeforeNavigate-details.

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

https://developer.chrome.com/extensions/webNavigation#event-onBeforeNavigate.

tap-on-committed-events clj/s macro

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

Fired when a navigation is committed. The document (and the resources it refers to, such as images and subframes) might still be downloading, but at least part of the document has been received from the server and the browser has decided to switch to the new document.

Events will be put on the |channel| with signature [::on-committed [details]] where:

|details| - https://developer.chrome.com/extensions/webNavigation#property-onCommitted-details.

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

https://developer.chrome.com/extensions/webNavigation#event-onCommitted.

tap-on-completed-events clj/s macro

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

Fired when a document, including the resources it refers to, is completely loaded and initialized.

Events will be put on the |channel| with signature [::on-completed [details]] where:

|details| - https://developer.chrome.com/extensions/webNavigation#property-onCompleted-details.

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

https://developer.chrome.com/extensions/webNavigation#event-onCompleted.

tap-on-created-navigation-target-events clj/s macro

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

Fired when a new window, or a new tab in an existing window, is created to host a navigation.

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

|details| - https://developer.chrome.com/extensions/webNavigation#property-onCreatedNavigationTarget-details.

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

https://developer.chrome.com/extensions/webNavigation#event-onCreatedNavigationTarget.

tap-on-dom-content-loaded-events clj/s macro

(tap-on-dom-content-loaded-events channel & args)

Fired when the page's DOM is fully constructed, but the referenced resources may not finish loading.

Events will be put on the |channel| with signature [::on-dom-content-loaded [details]] where:

|details| - https://developer.chrome.com/extensions/webNavigation#property-onDOMContentLoaded-details.

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

https://developer.chrome.com/extensions/webNavigation#event-onDOMContentLoaded.

tap-on-error-occurred-events clj/s macro

(tap-on-error-occurred-events channel & args)

Fired when an error occurs and the navigation is aborted. This can happen if either a network error occurred, or the user aborted the navigation.

Events will be put on the |channel| with signature [::on-error-occurred [details]] where:

|details| - https://developer.chrome.com/extensions/webNavigation#property-onErrorOccurred-details.

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

https://developer.chrome.com/extensions/webNavigation#event-onErrorOccurred.

tap-on-history-state-updated-events clj/s macro

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

Fired when the frame's history was updated to a new URL. All future events for that frame will use the updated URL.

Events will be put on the |channel| with signature [::on-history-state-updated [details]] where:

|details| - https://developer.chrome.com/extensions/webNavigation#property-onHistoryStateUpdated-details.

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

https://developer.chrome.com/extensions/webNavigation#event-onHistoryStateUpdated.

tap-on-reference-fragment-updated-events clj/s macro

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

Fired when the reference fragment of a frame was updated. All future events for that frame will use the updated URL.

Events will be put on the |channel| with signature [::on-reference-fragment-updated [details]] where:

|details| - https://developer.chrome.com/extensions/webNavigation#property-onReferenceFragmentUpdated-details.

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

https://developer.chrome.com/extensions/webNavigation#event-onReferenceFragmentUpdated.

tap-on-tab-replaced-events clj/s macro

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

Fired when the contents of the tab is replaced by a different (usually previously pre-rendered) tab.

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

|details| - https://developer.chrome.com/extensions/webNavigation#property-onTabReplaced-details.

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

https://developer.chrome.com/extensions/webNavigation#event-onTabReplaced.