chrome.experimental.settings
For information on how to use experimental APIs, see the chrome.experimental.* APIs page.
API reference: chrome.experimental.settings
Properties
getLastError
chrome.extensionlastError
Methods
clear
void
chrome.experimental.settings.clear(, function
callback)
Undocumented.
Removes all values from settings.
Parameters
-
callback
(
optional
enumerated
Type
array of
function
)
-
Undocumented.
- Callback on success, or on failure (in which case lastError will be set).
-
This parameter was added in version
.
You must omit this parameter in earlier versions,
and you may omit it in any version. If you require this
parameter, the manifest key
minimum_chrome_version
can ensure that your extension won't be run in an earlier browser version.
-
-
-
-
Returns
Callback function
The callback parameter should specify a function
that looks like this:
If you specify the callback parameter, it should
specify a function that looks like this:
function() {...};
This function was added in version .
If you require this function, the manifest key
minimum_chrome_version
can ensure that your extension won't be run in an earlier browser version.
get
void
chrome.experimental.settings.get(, string or array of string
keys, function
callback)
Undocumented.
Gets one or more values from settings.
Parameters
-
keys
(
optional
enumerated
Type
array of
string or array of string
)
-
Undocumented.
- A single key or a list of keys to get from settings. Leave empty to get the entire contents of settings; this should only be used for debugging.
-
This parameter was added in version
.
You must omit this parameter in earlier versions,
and you may omit it in any version. If you require this
parameter, the manifest key
minimum_chrome_version
can ensure that your extension won't be run in an earlier browser version.
-
-
-
-
-
callback
(
optional
enumerated
Type
array of
function
)
-
Undocumented.
- Callback with settings values, or on failure (in which case lastError will be set).
-
This parameter was added in version
.
You must omit this parameter in earlier versions,
and you may omit it in any version. If you require this
parameter, the manifest key
minimum_chrome_version
can ensure that your extension won't be run in an earlier browser version.
-
-
-
-
Returns
Callback function
The callback parameter should specify a function
that looks like this:
If you specify the callback parameter, it should
specify a function that looks like this:
function(object settings) {...};
-
settings
(
optional
enumerated
Type
array of
object
)
-
Undocumented.
- Object with given keys set to settings values.
-
This parameter was added in version
.
You must omit this parameter in earlier versions,
and you may omit it in any version. If you require this
parameter, the manifest key
minimum_chrome_version
can ensure that your extension won't be run in an earlier browser version.
-
-
-
-
This function was added in version .
If you require this function, the manifest key
minimum_chrome_version
can ensure that your extension won't be run in an earlier browser version.
remove
void
chrome.experimental.settings.remove(, string or array of string
keys, function
callback)
Undocumented.
Removes one or more values from settings.
Parameters
-
keys
(
optional
enumerated
Type
array of
string or array of string
)
-
Undocumented.
- A single key or a list of keys to remove from settings.
-
This parameter was added in version
.
You must omit this parameter in earlier versions,
and you may omit it in any version. If you require this
parameter, the manifest key
minimum_chrome_version
can ensure that your extension won't be run in an earlier browser version.
-
-
-
-
-
callback
(
optional
enumerated
Type
array of
function
)
-
Undocumented.
- Callback on success, or on failure (in which case lastError will be set).
-
This parameter was added in version
.
You must omit this parameter in earlier versions,
and you may omit it in any version. If you require this
parameter, the manifest key
minimum_chrome_version
can ensure that your extension won't be run in an earlier browser version.
-
-
-
-
Returns
Callback function
The callback parameter should specify a function
that looks like this:
If you specify the callback parameter, it should
specify a function that looks like this:
function() {...};
This function was added in version .
If you require this function, the manifest key
minimum_chrome_version
can ensure that your extension won't be run in an earlier browser version.
set
void
chrome.experimental.settings.set(, object
settings, function
callback)
Undocumented.
Sets multiple settings values.
Parameters
-
settings
(
optional
enumerated
Type
array of
object
)
-
Undocumented.
- Object to augment settings with. Values that cannot be serialized (functions, etc) will be ignored.
-
This parameter was added in version
.
You must omit this parameter in earlier versions,
and you may omit it in any version. If you require this
parameter, the manifest key
minimum_chrome_version
can ensure that your extension won't be run in an earlier browser version.
-
-
-
-
-
callback
(
optional
enumerated
Type
array of
function
)
-
Undocumented.
- Callback with settings values, or on failure (in which case lastError will be set).
-
This parameter was added in version
.
You must omit this parameter in earlier versions,
and you may omit it in any version. If you require this
parameter, the manifest key
minimum_chrome_version
can ensure that your extension won't be run in an earlier browser version.
-
-
-
-
Returns
Callback function
The callback parameter should specify a function
that looks like this:
If you specify the callback parameter, it should
specify a function that looks like this:
function(object settings) {...};
-
settings
(
optional
enumerated
Type
array of
object
)
-
Undocumented.
- Object with given keys set to settings values.
-
This parameter was added in version
.
You must omit this parameter in earlier versions,
and you may omit it in any version. If you require this
parameter, the manifest key
minimum_chrome_version
can ensure that your extension won't be run in an earlier browser version.
-
-
-
-
This function was added in version .
If you require this function, the manifest key
minimum_chrome_version
can ensure that your extension won't be run in an earlier browser version.
Events
event name
chrome.bookmarksonEvent.addListener(function(Type param1, Type param2) {...}, Type opt_param1, Type opt_param2);
Undocumented.
A description from the json schema def of the event goes here.
Extra parameters to addListener
Listener returns