chromex.app.settings-private — binaryage/chromex 0.9.3

clj

Use the chrome.settingsPrivate API to get or set preferences from the settings UI. Access is restricted to a whitelisted set of user facing preferences.

• available since Chrome master

api-table clj

gen-call clj

gen-wrap clj/s macro

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

get-all-prefs clj/s macro

(get-all-prefs)

Gets an array of all the prefs.

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

|prefs| - ?

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.

get-all-prefs* cljs

(get-all-prefs* config)

get-default-zoom clj/s macro

(get-default-zoom)

Gets the default page zoom factor. Possible values are currently between 0.25 and 5. For a full list, see zoom::kPresetZoomFactors.

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

|zoom| - ?

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.

get-default-zoom* cljs

(get-default-zoom* config)

get-pref clj/s macro

(get-pref name)

Gets the value of a specific pref.

|name| - ?

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

|pref| - ?

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.

get-pref* cljs

(get-pref* config name)

on-prefs-changed* cljs

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

set-default-zoom clj/s macro

(set-default-zoom zoom)

Sets the page zoom factor. Must be less than 0.001 different than a value in zoom::kPresetZoomFactors.

|zoom| - ?

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

|success| - ?

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.

set-default-zoom* cljs

(set-default-zoom* config zoom)

set-pref clj/s macro

(set-pref name value)

(set-pref name value page-id)

Sets a pref value.

|name| - The name of the pref. |value| - The new value of the pref. |page-id| - An optional user metrics identifier.

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

|success| - ?

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.

set-pref* cljs

(set-pref* config name value page-id)

tap-all-events clj/s macro

(tap-all-events chan)

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

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

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

Fired when a set of prefs has changed.|prefs| The prefs that changed.

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

|prefs| - ?

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