Liking cljdoc? Tell your friends :D

chromex.app.management

clj

The chrome.management API provides ways to manage the list of extensions/apps that are installed and running. It is particularly useful for extensions that override the built-in New Tab page.

The chrome.management API provides ways to manage the list of extensions/apps that are installed and running. It is
particularly useful for extensions that override the built-in New Tab page.

  * available since Chrome 24
  * https://developer.chrome.com/apps/management
raw docstring

api-tableclj

source

create-app-shortcutclj/smacro

(create-app-shortcut id)

Display options to create shortcuts for an app. On Mac, only packaged app shortcuts can be created.

|id| - This should be the id from an app item of 'management.ExtensionInfo'.

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/management#method-createAppShortcut.

Display options to create shortcuts for an app. On Mac, only packaged app shortcuts can be created.

  |id| - This should be the id from an app item of 'management.ExtensionInfo'.

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/management#method-createAppShortcut.
sourceraw docstring

create-app-shortcut*cljs

(create-app-shortcut* config id)
source

gen-callclj

source

gen-wrapclj/smacro

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

(generate-app-for-link url title)

Generate an app for a URL. Returns the generated bookmark app.

|url| - The URL of a web page. The scheme of the URL can only be 'http' or 'https'. |title| - The title of the generated app.

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

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

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/management#method-generateAppForLink.

Generate an app for a URL. Returns the generated bookmark app.

  |url| - The URL of a web page. The scheme of the URL can only be 'http' or 'https'.
  |title| - The title of the generated app.

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

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

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/management#method-generateAppForLink.
sourceraw docstring

generate-app-for-link*cljs

(generate-app-for-link* config url title)
source

getclj/smacro

(get id)

Returns information about the installed extension, app, or theme that has the given ID.

|id| - The ID from an item of 'management.ExtensionInfo'.

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

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

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

Returns information about the installed extension, app, or theme that has the given ID.

  |id| - The ID from an item of 'management.ExtensionInfo'.

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

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

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

get*cljs

(get* config id)
source

get-allclj/smacro

(get-all)

Returns a list of information about installed extensions and apps.

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

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

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

Returns a list of information about installed extensions and apps.

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

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

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

get-all*cljs

(get-all* config)
source

get-permission-warnings-by-idclj/smacro

(get-permission-warnings-by-id id)

Returns a list of permission warnings for the given extension id.

|id| - The ID of an already installed extension.

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

|permission-warnings| - https://developer.chrome.com/apps/management#property-callback-permissionWarnings.

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/management#method-getPermissionWarningsById.

Returns a list of permission warnings for the given extension id.

  |id| - The ID of an already installed extension.

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

  |permission-warnings| - https://developer.chrome.com/apps/management#property-callback-permissionWarnings.

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/management#method-getPermissionWarningsById.
sourceraw docstring

get-permission-warnings-by-id*cljs

(get-permission-warnings-by-id* config id)
source

get-permission-warnings-by-manifestclj/smacro

(get-permission-warnings-by-manifest manifest-str)

Returns a list of permission warnings for the given extension manifest string. Note: This function can be used without requesting the 'management' permission in the manifest.

|manifest-str| - Extension manifest JSON string.

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

|permission-warnings| - https://developer.chrome.com/apps/management#property-callback-permissionWarnings.

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/management#method-getPermissionWarningsByManifest.

Returns a list of permission warnings for the given extension manifest string. Note: This function can be used without
requesting the 'management' permission in the manifest.

  |manifest-str| - Extension manifest JSON string.

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

  |permission-warnings| - https://developer.chrome.com/apps/management#property-callback-permissionWarnings.

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/management#method-getPermissionWarningsByManifest.
sourceraw docstring

get-permission-warnings-by-manifest*cljs

(get-permission-warnings-by-manifest* config manifest-str)
source

get-selfclj/smacro

(get-self)

Returns information about the calling extension, app, or theme. Note: This function can be used without requesting the 'management' permission in the manifest.

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

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

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/management#method-getSelf.

Returns information about the calling extension, app, or theme. Note: This function can be used without requesting the
'management' permission in the manifest.

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

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

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/management#method-getSelf.
sourceraw docstring

get-self*cljs

(get-self* config)
source

launch-appclj/smacro

(launch-app id)

Launches an application.

|id| - The extension id of the application.

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/management#method-launchApp.

Launches an application.

  |id| - The extension id of the application.

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/management#method-launchApp.
sourceraw docstring

launch-app*cljs

(launch-app* config id)
source

on-disabled*cljs

(on-disabled* config channel & args)
source

on-enabled*cljs

(on-enabled* config channel & args)
source

on-installed*cljs

(on-installed* config channel & args)
source

on-uninstalled*cljs

(on-uninstalled* config channel & args)
source

set-enabledclj/smacro

(set-enabled id enabled)

Enables or disables an app or extension. In most cases this function must be called in the context of a user gesture (e.g. an onclick handler for a button), and may present the user with a native confirmation UI as a way of preventing abuse.

|id| - This should be the id from an item of 'management.ExtensionInfo'. |enabled| - Whether this item should be enabled or disabled.

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/management#method-setEnabled.

Enables or disables an app or extension. In most cases this function must be called in the context of a user gesture (e.g.
an onclick handler for a button), and may present the user with a native confirmation UI as a way of preventing abuse.

  |id| - This should be the id from an item of 'management.ExtensionInfo'.
  |enabled| - Whether this item should be enabled or disabled.

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/management#method-setEnabled.
sourceraw docstring

set-enabled*cljs

(set-enabled* config id enabled)
source

set-launch-typeclj/smacro

(set-launch-type id launch-type)

Set the launch type of an app.

|id| - This should be the id from an app item of 'management.ExtensionInfo'. |launch-type| - The target launch type. Always check and make sure this launch type is in 'ExtensionInfo.availableLaunchTypes', because the available launch types vary on different platforms and configurations.

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/management#method-setLaunchType.

Set the launch type of an app.

  |id| - This should be the id from an app item of 'management.ExtensionInfo'.
  |launch-type| - The target launch type. Always check and make sure this launch type is in
                  'ExtensionInfo.availableLaunchTypes', because the available launch types vary on different platforms
                  and configurations.

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/management#method-setLaunchType.
sourceraw docstring

set-launch-type*cljs

(set-launch-type* config id launch-type)
source

tap-all-eventsclj/smacro

(tap-all-events chan)

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

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

tap-on-disabled-eventsclj/smacro

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

Fired when an app or extension has been disabled.

Events will be put on the |channel| with signature [::on-disabled [info]] where:

|info| - https://developer.chrome.com/apps/management#property-onDisabled-info.

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

https://developer.chrome.com/apps/management#event-onDisabled.

Fired when an app or extension has been disabled.

Events will be put on the |channel| with signature [::on-disabled [info]] where:

  |info| - https://developer.chrome.com/apps/management#property-onDisabled-info.

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

https://developer.chrome.com/apps/management#event-onDisabled.
sourceraw docstring

tap-on-enabled-eventsclj/smacro

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

Fired when an app or extension has been enabled.

Events will be put on the |channel| with signature [::on-enabled [info]] where:

|info| - https://developer.chrome.com/apps/management#property-onEnabled-info.

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

https://developer.chrome.com/apps/management#event-onEnabled.

Fired when an app or extension has been enabled.

Events will be put on the |channel| with signature [::on-enabled [info]] where:

  |info| - https://developer.chrome.com/apps/management#property-onEnabled-info.

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

https://developer.chrome.com/apps/management#event-onEnabled.
sourceraw docstring

tap-on-installed-eventsclj/smacro

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

Fired when an app or extension has been installed.

Events will be put on the |channel| with signature [::on-installed [info]] where:

|info| - https://developer.chrome.com/apps/management#property-onInstalled-info.

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

https://developer.chrome.com/apps/management#event-onInstalled.

Fired when an app or extension has been installed.

Events will be put on the |channel| with signature [::on-installed [info]] where:

  |info| - https://developer.chrome.com/apps/management#property-onInstalled-info.

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

https://developer.chrome.com/apps/management#event-onInstalled.
sourceraw docstring

tap-on-uninstalled-eventsclj/smacro

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

Fired when an app or extension has been uninstalled.

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

|id| - The id of the extension, app, or theme that was uninstalled.

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

https://developer.chrome.com/apps/management#event-onUninstalled.

Fired when an app or extension has been uninstalled.

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

  |id| - The id of the extension, app, or theme that was uninstalled.

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

https://developer.chrome.com/apps/management#event-onUninstalled.
sourceraw docstring

uninstallclj/smacro

(uninstall id)
(uninstall id options)

Uninstalls a currently installed app or extension.

|id| - This should be the id from an item of 'management.ExtensionInfo'. |options| - https://developer.chrome.com/apps/management#property-uninstall-options.

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/management#method-uninstall.

Uninstalls a currently installed app or extension.

  |id| - This should be the id from an item of 'management.ExtensionInfo'.
  |options| - https://developer.chrome.com/apps/management#property-uninstall-options.

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/management#method-uninstall.
sourceraw docstring

uninstall*cljs

(uninstall* config id options)
source

uninstall-selfclj/smacro

(uninstall-self)
(uninstall-self options)

Uninstalls the calling extension. Note: This function can be used without requesting the 'management' permission in the manifest.

|options| - https://developer.chrome.com/apps/management#property-uninstallSelf-options.

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/management#method-uninstallSelf.

Uninstalls the calling extension. Note: This function can be used without requesting the 'management' permission in the
manifest.

  |options| - https://developer.chrome.com/apps/management#property-uninstallSelf-options.

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/management#method-uninstallSelf.
sourceraw docstring

uninstall-self*cljs

(uninstall-self* config options)
source

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

× close