chromex.app.management — binaryage/chromex 0.9.3

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.

• available since Chrome 36
• https://developer.chrome.com/apps/management

api-table clj

can-install-replacement-android-app clj/s macro

(can-install-replacement-android-app)

Checks if the replacement android app can be installed. Errors generated by this API are reported by setting 'runtime.lastError' and executing the function's regular callback.

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-canInstallReplacementAndroidApp.

can-install-replacement-android-app* cljs

(can-install-replacement-android-app* config)

create-app-shortcut clj/s macro

(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.

create-app-shortcut* cljs

(create-app-shortcut* config id)

gen-call clj

gen-wrap clj/s macro

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

generate-app-for-link clj/s macro

(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-app-for-link* cljs

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

get clj/s macro

(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.

get* cljs

(get* config id)

get-all clj/s macro

(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.

get-all* cljs

(get-all* config)

get-permission-warnings-by-id clj/s macro

(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.

get-permission-warnings-by-id* cljs

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

get-permission-warnings-by-manifest clj/s macro

(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.

get-permission-warnings-by-manifest* cljs

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

get-self clj/s macro

(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.

get-self* cljs

(get-self* config)

install-replacement-android-app clj/s macro

(install-replacement-android-app)

Prompts the user to install the replacement Android app from the manifest. Errors generated by this API are reported by setting 'runtime.lastError' and executing the function's regular callback.

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-installReplacementAndroidApp.

install-replacement-android-app* cljs

(install-replacement-android-app* config)

install-replacement-web-app clj/s macro

(install-replacement-web-app)

Launches the replacement_web_app specified in the manifest. Prompts the user to install if not already installed.

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-installReplacementWebApp.

install-replacement-web-app* cljs

(install-replacement-web-app* config)

launch-app clj/s macro

(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.

launch-app* cljs

(launch-app* config id)

on-disabled* cljs

(on-disabled* config channel & args)

on-enabled* cljs

(on-enabled* config channel & args)

on-installed* cljs

(on-installed* config channel & args)

on-uninstalled* cljs

(on-uninstalled* config channel & args)

set-enabled clj/s macro

(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.

set-enabled* cljs

(set-enabled* config id enabled)

set-launch-type clj/s macro

(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-launch-type* cljs

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

tap-all-events clj/s macro

(tap-all-events chan)

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

tap-on-disabled-events clj/s macro

(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.

tap-on-enabled-events clj/s macro

(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.

tap-on-installed-events clj/s macro

(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.

tap-on-uninstalled-events clj/s macro

(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.

uninstall clj/s macro

(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.

uninstall* cljs

(uninstall* config id options)

uninstall-self clj/s macro

(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.

uninstall-self* cljs

(uninstall-self* config options)