chromex.ext.autotest-private — binaryage/chromex 0.9.3

clj

API for integration testing. To be used on test images with a test component extension.

• available since Chrome 36

activate-accelerator clj/s macro

(activate-accelerator accelerator)

Activates shortcut.

|accelerator| - the accelerator to activate.

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.

activate-accelerator* cljs

(activate-accelerator* config accelerator)

activate-adjacent-desks-to-target-index clj/s macro

(activate-adjacent-desks-to-target-index index)

Activates the desk at the given |index| by chaining multiple activate-desk animations.

|index| - the zero-based index of the desk desired to be activated.

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.

activate-adjacent-desks-to-target-index* cljs

(activate-adjacent-desks-to-target-index* config index)

activate-desk-at-index clj/s macro

(activate-desk-at-index index)

Activates the desk at the given |index| triggering the activate-desk animation.

|index| - the zero-based index of the desk desired to be activated.

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.

activate-desk-at-index* cljs

(activate-desk-at-index* config index)

api-table clj

arc-app-tracing-start clj/s macro

(arc-app-tracing-start)

Start ARC performance tracing for the active ARC app window.

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.

arc-app-tracing-start* cljs

(arc-app-tracing-start* config)

arc-app-tracing-stop-and-analyze clj/s macro

(arc-app-tracing-stop-and-analyze)

Stop ARC performance tracing if it was started and analyze results.

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

|info| - ?

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.

arc-app-tracing-stop-and-analyze* cljs

(arc-app-tracing-stop-and-analyze* config)

bootstrap-machine-learning-service clj/s macro

(bootstrap-machine-learning-service)

Makes a basic request to ML Service, triggering 1. ML Service daemon startup, and 2. the initial D-Bus -> Mojo IPC bootstrap.

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.

bootstrap-machine-learning-service* cljs

(bootstrap-machine-learning-service* config)

close-app clj/s macro

(close-app app-id)

Closes an application the given appId in case it was running.

|app-id| - ?

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.

close-app* cljs

(close-app* config app-id)

close-app-window clj/s macro

(close-app-window id)

Closes an app window given by 'id'.

|id| - the id of the window

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.

close-app-window* cljs

(close-app-window* config id)

create-new-desk clj/s macro

(create-new-desk)

Creates a new desk if the maximum number of desks has not been reached.

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.

create-new-desk* cljs

(create-new-desk* config)

disable-automation clj/s macro

(disable-automation)

Disables the automation feature. Note that the event handlers and caches of automation nodes still remain in the test extension and so the next automation.getDesktop will miss initialization. The caller should ensure invalidation of those information (i.e. reloading the entire background page).

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.

disable-automation* cljs

(disable-automation* config)

disable-switch-access-dialog clj/s macro

(disable-switch-access-dialog)

When neccesary, disables showing the dialog when Switch Access is disabled.

disable-switch-access-dialog* cljs

(disable-switch-access-dialog* config)

enable-assistant-and-wait-for-ready clj/s macro

(enable-assistant-and-wait-for-ready)

Bring up the Assistant service, and wait for the ready signal.

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.

enable-assistant-and-wait-for-ready* cljs

(enable-assistant-and-wait-for-ready* config)

export-crostini clj/s macro

(export-crostini path)

Export the crostini container.

|path| - The path in Downloads to save the export.

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.

export-crostini* cljs

(export-crostini* config path)

gen-call clj

gen-wrap clj/s macro

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

get-all-enterprise-policies clj/s macro

(get-all-enterprise-policies)

Get state of the policies. Will contain device policies and policies from the active profile. The policy values are formatted as they would be for exporting in chrome://policy.

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

|all-policies| - ?

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-enterprise-policies* cljs

(get-all-enterprise-policies* config)

get-all-installed-apps clj/s macro

(get-all-installed-apps)

Get the list of all installed applications

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

|apps| - ?

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-installed-apps* cljs

(get-all-installed-apps* config)

get-app-window-list clj/s macro

(get-app-window-list)

Get information on all application windows. Callback will be called with the list of |AppWindowInfo| dictionary.

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

|window-list| - ?

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-app-window-list* cljs

(get-app-window-list* config)

get-arc-app clj/s macro

(get-arc-app app-id)

Gets information about the requested ARC app.

|app-id| - ?

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

|package| - ?

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-arc-app* cljs

(get-arc-app* config app-id)

get-arc-package clj/s macro

(get-arc-package package-name)

Gets information about requested ARC package.

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

|package| - ?

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-arc-package* cljs

(get-arc-package* config package-name)

get-arc-start-time clj/s macro

(get-arc-start-time)

Get ARC start time.

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

|start-time| - ?

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-arc-start-time* cljs

(get-arc-start-time* config)

get-arc-state clj/s macro

(get-arc-state)

Get state of the ARC session.

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| - ?

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-arc-state* cljs

(get-arc-state* config)

get-clipboard-text-data clj/s macro

(get-clipboard-text-data)

Get text from ui::Clipboard.

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

|data| - ?

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-clipboard-text-data* cljs

(get-clipboard-text-data* config)

get-extensions-info clj/s macro

(get-extensions-info)

Get info about installed extensions.

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

|info| - ?

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-extensions-info* cljs

(get-extensions-info* config)

get-play-store-state clj/s macro

(get-play-store-state)

Get state of the Play Store.

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| - ?

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-play-store-state* cljs

(get-play-store-state* config)

get-primary-display-scale-factor clj/s macro

(get-primary-display-scale-factor)

Get the primary display scale factor. |callback| is invoked with the scale factor.

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

|scale-factor| - ?

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-primary-display-scale-factor* cljs

(get-primary-display-scale-factor* config)

get-printer-list clj/s macro

(get-printer-list)

Get list of available printers

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

|printers| - ?

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-printer-list* cljs

(get-printer-list* config)

get-registered-system-web-apps clj/s macro

(get-registered-system-web-apps)

Returns the number of system web apps that should be 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 [system-apps] where:

|system-apps| - ?

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-registered-system-web-apps* cljs

(get-registered-system-web-apps* config)

get-scrollable-shelf-info-for-state clj/s macro

(get-scrollable-shelf-info-for-state state)

Fetches ui information of scrollable shelf view for the given shelf state. This function does not change scrollable shelf. [deprecated='Use getShelfUIInfoForState()']

|state| - ?

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

|info| - ?

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-scrollable-shelf-info-for-state* cljs

(get-scrollable-shelf-info-for-state* config state)

get-shelf-alignment clj/s macro

(get-shelf-alignment display-id)

Get the shelf alignment.

|display-id| - display that contains the shelf. |callback| is invoked with the shelf alignment type.

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

|alignment| - ?

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-shelf-alignment* cljs

(get-shelf-alignment* config display-id)

get-shelf-auto-hide-behavior clj/s macro

(get-shelf-auto-hide-behavior display-id)

Get the shelf auto hide behavior.

|display-id| - display that contains the shelf. |callback| is invoked with the shelf auto hide behavior. Possible behavior values are: 'always', 'never' or 'hidden'.

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

|behavior| - ?

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-shelf-auto-hide-behavior* cljs

(get-shelf-auto-hide-behavior* config display-id)

get-shelf-items clj/s macro

(get-shelf-items)

Get the list of all shelf items

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

|items| - ?

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-shelf-items* cljs

(get-shelf-items* config)

get-shelf-ui-info-for-state clj/s macro

(get-shelf-ui-info-for-state state)

Fetches UI information of shelf (including scrollable shelf and hotseat) for the given shelf state. This function does not change any shelf component.

|state| - ?

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

|info| - ?

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-shelf-ui-info-for-state* cljs

(get-shelf-ui-info-for-state* config state)

get-visible-notifications clj/s macro

(get-visible-notifications)

Get visible notifications on the system.

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

|notifications| - ?

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-visible-notifications* cljs

(get-visible-notifications* config)

import-crostini clj/s macro

(import-crostini path)

Import the crostini container.

|path| - The path in Downloads to read the import.

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.

import-crostini* cljs

(import-crostini* config path)

initialize-events clj/s macro

(initialize-events)

Must be called to allow autotestPrivateAPI events to be fired.

initialize-events* cljs

(initialize-events* config)

install-pwa-for-current-url clj/s macro

(install-pwa-for-current-url timeout-ms)

Installs the Progressive Web App (PWA) that is in the current URL.

|timeout-ms| - Timeout in milliseconds for the operation to complete.

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

|app-id| - ?

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.

install-pwa-for-current-url* cljs

(install-pwa-for-current-url* config timeout-ms)

is-app-shown clj/s macro

(is-app-shown app-id)

Returns true if requested app is shown in Chrome.

|app-id| - ?

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

|app-shown| - ?

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.

is-app-shown* cljs

(is-app-shown* config app-id)

is-arc-package-list-initial-refreshed clj/s macro

(is-arc-package-list-initial-refreshed)

Whether the local list of installed ARC packages has been refreshed for the first time after user login.

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

|refreshed| - ?

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.

is-arc-package-list-initial-refreshed* cljs

(is-arc-package-list-initial-refreshed* config)

is-arc-provisioned clj/s macro

(is-arc-provisioned)

Returns true if ARC is provisioned. [deprecated='Use getArcState()']

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

|arc-provisioned| - ?

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.

is-arc-provisioned* cljs

(is-arc-provisioned* config)

is-tablet-mode-enabled clj/s macro

(is-tablet-mode-enabled)

Get the tablet mode enabled status. |callback| is invoked with the tablet mode enablement status.

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

|enabled| - ?

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.

is-tablet-mode-enabled* cljs

(is-tablet-mode-enabled* config)

launch-app clj/s macro

(launch-app app-id)

Launches an application from the launcher with the given appId.

|app-id| - ?

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.

launch-app* cljs

(launch-app* config app-id)

launch-arc-app clj/s macro

(launch-arc-app app-id intent)

Launches ARC app with optional intent. Returns true if ARC is active, app exists and launch request is passed to Android.

|app-id| - ? |intent| - ?

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

|app-launched| - ?

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.

launch-arc-app* cljs

(launch-arc-app* config app-id intent)

launch-system-web-app clj/s macro

(launch-system-web-app app-name url)

Launches an system web app from the launcher with the given app name and url.

|app-name| - ? |url| - ?

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.

launch-system-web-app* cljs

(launch-system-web-app* config app-name url)

lock-screen clj/s macro

(lock-screen)

Locks the screen.

lock-screen* cljs

(lock-screen* config)

login-status clj/s macro

(login-status)

Get login status.

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

|status| - ?

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.

login-status* cljs

(login-status* config)

logout clj/s macro

(logout)

Logout of a user session.

logout* cljs

(logout* config)

mouse-click clj/s macro

(mouse-click button)

Create mouse events to cause a mouse click.

|button| - the mouse button for the click event.

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.

mouse-click* cljs

(mouse-click* config button)

mouse-move clj/s macro

(mouse-move location duration-in-ms)

Create mouse events to move a mouse cursor to the location. This can cause a dragging if a button is pressed. It starts from the last mouse location. It does not support the move or drag across display boundaries.

|location| - the target location (in display's coordinate). |duration-in-ms| - the duration (in milliseconds) for the mouse movement. The mouse will move linearly. 0 means moving immediately.

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.

mouse-move* cljs

(mouse-move* config location duration-in-ms)

mouse-press clj/s macro

(mouse-press button)

Create a mouse event to cause mouse pressing. The mouse button stays in the pressed state.

|button| - the mouse button to be pressed.

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.

mouse-press* cljs

(mouse-press* config button)

mouse-release clj/s macro

(mouse-release button)

Create a mouse event to release a mouse button. This does nothing and returns immediately if the specified button is not pressed.

|button| - the mouse button to be released.

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.

mouse-release* cljs

(mouse-release* config button)

on-clipboard-data-changed* cljs

(on-clipboard-data-changed* config channel & args)

pin-shelf-icon clj/s macro

(pin-shelf-icon app-id)

Create a pin on shelf for the app specified by |appId|.

|app-id| - ?

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.

pin-shelf-icon* cljs

(pin-shelf-icon* config app-id)

refresh-enterprise-policies clj/s macro

(refresh-enterprise-policies)

Refreshes the Enterprise Policies.

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.

refresh-enterprise-policies* cljs

(refresh-enterprise-policies* config)

register-component clj/s macro

(register-component name path)

Register a component with CrOSComponentManager.

|name| - The name of the component. |path| - Path to the component.

register-component* cljs

(register-component* config name path)

remove-active-desk clj/s macro

(remove-active-desk)

Removes the currently active desk and triggers the remove-desk animation.

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.

remove-active-desk* cljs

(remove-active-desk* config)

remove-all-notifications clj/s macro

(remove-all-notifications)

Remove all notifications.

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.

remove-all-notifications* cljs

(remove-all-notifications* config)

remove-printer clj/s macro

(remove-printer printer-id)

Remove printer.

|printer-id| - ?

remove-printer* cljs

(remove-printer* config printer-id)

restart clj/s macro

(restart)

Restart the browser.

restart* cljs

(restart* config)

run-crostini-installer clj/s macro

(run-crostini-installer)

Run the crostini installer GUI to install the default crostini vm / container and create sshfs mount. The installer launches the crostini terminal app on completion. The installer expects that crostini is 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.

run-crostini-installer* cljs

(run-crostini-installer* config)

run-crostini-uninstaller clj/s macro

(run-crostini-uninstaller)

Run the crostini uninstaller GUI to remove the default crostini vm / container. The callback is invoked upon completion.

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.

run-crostini-uninstaller* cljs

(run-crostini-uninstaller* config)

send-assistant-text-query clj/s macro

(send-assistant-text-query query timeout-ms)

Sends a text query via Google Assistant.

|query| - ? |timeout-ms| - ?

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

|status| - ?

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.

send-assistant-text-query* cljs

(send-assistant-text-query* config query timeout-ms)

set-app-window-state clj/s macro

(set-app-window-state id change)

Send WM event to change the app window's window state.

|id| - the id of the window |change| - WM event type to send to the app window.

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

|current-type| - ?

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-app-window-state* cljs

(set-app-window-state* config id change)

set-arc-app-window-focus clj/s macro

(set-arc-app-window-focus package-name)

Set ARC app window focused.

|package-name| - the package name of the ARC app window.

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.

set-arc-app-window-focus* cljs

(set-arc-app-window-focus* config package-name)

set-arc-touch-mode clj/s macro

(set-arc-touch-mode enabled)

Sends ARC touch mode enabled or disabled.

|enabled| - ?

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.

set-arc-touch-mode* cljs

(set-arc-touch-mode* config enabled)

set-assistant-enabled clj/s macro

(set-assistant-enabled enabled timeout-ms)

Enables/disables the Google Assistant.

|enabled| - ? |timeout-ms| - ?

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.

set-assistant-enabled* cljs

(set-assistant-enabled* config enabled timeout-ms)

set-clipboard-text-data clj/s macro

(set-clipboard-text-data data)

Set text in ui::Clipbaord.

|data| - ?

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.

set-clipboard-text-data* cljs

(set-clipboard-text-data* config data)

set-crostini-app-scaled clj/s macro

(set-crostini-app-scaled app-id scaled)

Enable/disable a Crostini app's 'scaled' property.

|app-id| - The Crostini application ID. |scaled| - The app is 'scaled' when shown, which means it uses low display density.

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.

set-crostini-app-scaled* cljs

(set-crostini-app-scaled* config app-id scaled)

set-crostini-enabled clj/s macro

(set-crostini-enabled enabled)

Enable/disable Crostini in preferences.

|enabled| - Enable Crostini.

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.

set-crostini-enabled* cljs

(set-crostini-enabled* config enabled)

set-metrics-enabled clj/s macro

(set-metrics-enabled enabled)

Enable/disable metrics reporting in preferences.

|enabled| - Enable metrics reporting.

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.

set-metrics-enabled* cljs

(set-metrics-enabled* config enabled)

set-mouse-reverse-scroll clj/s macro

(set-mouse-reverse-scroll enabled)

Turn on/off reverse scrolling for mice.

|enabled| - if set, enable reverse scrolling.

set-mouse-reverse-scroll* cljs

(set-mouse-reverse-scroll* config enabled)

set-mouse-sensitivity clj/s macro

(set-mouse-sensitivity value)

Set the mouse pointer sensitivity setting.

|value| - the pointer sensitivity setting index.

set-mouse-sensitivity* cljs

(set-mouse-sensitivity* config value)

set-natural-scroll clj/s macro

(set-natural-scroll enabled)

Turn on/off Australian scrolling for devices other than wheel mouse.

|enabled| - if set, enable Australian scrolling.

set-natural-scroll* cljs

(set-natural-scroll* config enabled)

set-overview-mode-state clj/s macro

(set-overview-mode-state start)

Enter or exit the overview mode.

|start| - whether entering to or exiting from the overview mode.

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

|finished| - ?

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-overview-mode-state* cljs

(set-overview-mode-state* config start)

set-play-store-enabled clj/s macro

(set-play-store-enabled enabled)

Enable/disable the Play Store.

|enabled| - if set, enable the Play Store.

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.

set-play-store-enabled* cljs

(set-play-store-enabled* config enabled)

set-plugin-vm-policy clj/s macro

(set-plugin-vm-policy image-url image-hash license-key)

Sets mock Plugin VM policy.

|image-url| - URL to the image to install. |image-hash| - Hash for the provided image. |license-key| - License key for Plugin VM.

set-plugin-vm-policy* cljs

(set-plugin-vm-policy* config image-url image-hash license-key)

set-primary-button-right clj/s macro

(set-primary-button-right right)

Swap the primary mouse button for left click.

|right| - if set, swap the primary mouse button.

set-primary-button-right* cljs

(set-primary-button-right* config right)

set-shelf-alignment clj/s macro

(set-shelf-alignment display-id alignment)

Set the shelf alignment.

|display-id| - display that contains the shelf. |alignment| - the type of alignment to set.

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.

set-shelf-alignment* cljs

(set-shelf-alignment* config display-id alignment)

set-shelf-auto-hide-behavior clj/s macro

(set-shelf-auto-hide-behavior display-id behavior)

Set the shelf auto hide behavior.

|display-id| - display that contains the shelf. |behavior| - an enum of 'always', 'never' or 'hidden'.

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.

set-shelf-auto-hide-behavior* cljs

(set-shelf-auto-hide-behavior* config display-id behavior)

set-tablet-mode-enabled clj/s macro

(set-tablet-mode-enabled enabled)

Enable/disable tablet mode. After calling this function, it won't be possible to physically switch to/from tablet mode since that functionality will be disabled.

|enabled| - if set, enable tablet mode.

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

|enabled| - ?

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-tablet-mode-enabled* cljs

(set-tablet-mode-enabled* config enabled)

set-tap-dragging clj/s macro

(set-tap-dragging enabled)

Turn on/off tap dragging for the touchpad.

|enabled| - if set, enable tap dragging.

set-tap-dragging* cljs

(set-tap-dragging* config enabled)

set-tap-to-click clj/s macro

(set-tap-to-click enabled)

Turn on/off tap-to-click for the touchpad.

|enabled| - if set, enable tap-to-click.

set-tap-to-click* cljs

(set-tap-to-click* config enabled)

set-three-finger-click clj/s macro

(set-three-finger-click enabled)

Turn on/off three finger click for the touchpad.

|enabled| - if set, enable three finger click.

set-three-finger-click* cljs

(set-three-finger-click* config enabled)

set-touchpad-sensitivity clj/s macro

(set-touchpad-sensitivity value)

Set the touchpad pointer sensitivity setting.

|value| - the pointer sensitivity setting index.

set-touchpad-sensitivity* cljs

(set-touchpad-sensitivity* config value)

set-whitelisted-pref clj/s macro

(set-whitelisted-pref pref-name value)

Set value for the specified user pref in the pref tree.

|pref-name| - ? |value| - ?

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.

set-whitelisted-pref* cljs

(set-whitelisted-pref* config pref-name value)

set-window-bounds clj/s macro

(set-window-bounds id bounds display-id)

Sends a WM event to change a window's bounds and/or the display it is on.

|id| - the id of the window. |bounds| - bounds the window should be set to. |display-id| - id of display to move the window to.

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| - ?

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-window-bounds* cljs

(set-window-bounds* config id bounds display-id)

show-plugin-vm-installer clj/s macro

(show-plugin-vm-installer)

Shows the Plugin VM installer. Does not start installation.

show-plugin-vm-installer* cljs

(show-plugin-vm-installer* config)

show-virtual-keyboard-if-enabled clj/s macro

(show-virtual-keyboard-if-enabled)

Show virtual keyboard of the current input method if it's available.

show-virtual-keyboard-if-enabled* cljs

(show-virtual-keyboard-if-enabled* config)

shutdown clj/s macro

(shutdown force)

Shutdown the browser.

|force| - if set, ignore ongoing downloads and onunbeforeunload handlers.

shutdown* cljs

(shutdown* config force)

simulate-asan-memory-bug clj/s macro

(simulate-asan-memory-bug)

Simulates a memory access bug for asan testing.

simulate-asan-memory-bug* cljs

(simulate-asan-memory-bug* config)

start-smoothness-tracking clj/s macro

(start-smoothness-tracking)

(start-smoothness-tracking display-id)

Starts smoothness tracking for a display. If the display id is not specified, the primary display is used. Otherwise, the display specified by the display id is used.

|display-id| - ?

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.

start-smoothness-tracking* cljs

(start-smoothness-tracking* config display-id)

start-throughput-tracker-data-collection clj/s macro

(start-throughput-tracker-data-collection)

Starts to ui::ThroughputTracker data collection for tracked animations.

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.

start-throughput-tracker-data-collection* cljs

(start-throughput-tracker-data-collection* config)

start-tracing clj/s macro

(start-tracing config)

Starts Chrome tracing.

|config| - the tracing configuration.

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.

start-tracing* cljs

(start-tracing* config config)

stop-smoothness-tracking clj/s macro

(stop-smoothness-tracking)

(stop-smoothness-tracking display-id)

Stops smoothness tracking for a display and report the smoothness. If the display id is not specified, the primary display is used. Otherwise, the display specified by the display id is used.

|display-id| - ?

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

|smoothness| - ?

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.

stop-smoothness-tracking* cljs

(stop-smoothness-tracking* config display-id)

stop-throughput-tracker-data-collection clj/s macro

(stop-throughput-tracker-data-collection)

Stops ui::ThroughputTracker data collection and reports the collected data since the start.

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

|data| - ?

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.

stop-throughput-tracker-data-collection* cljs

(stop-throughput-tracker-data-collection* config)

stop-tracing clj/s macro

(stop-tracing)

Stops Chrome tracing.

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

|data| - ?

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.

stop-tracing* cljs

(stop-tracing* config)

swap-windows-in-split-view clj/s macro

(swap-windows-in-split-view)

Swap the windows in the split view.

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.

swap-windows-in-split-view* cljs

(swap-windows-in-split-view* config)

take-screenshot clj/s macro

(take-screenshot)

Takes a screenshot and returns the data in base64 encoded PNG format.

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

|base64-png| - ?

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.

take-screenshot* cljs

(take-screenshot* config)

take-screenshot-for-display clj/s macro

(take-screenshot-for-display display-id)

Tasks a screenshot for a display.

|display-id| - the display id of the display.

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

|base64-png| - ?

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.

take-screenshot-for-display* cljs

(take-screenshot-for-display* config display-id)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.ext.autotest-private namespace.

tap-on-clipboard-data-changed-events clj/s macro

(tap-on-clipboard-data-changed-events channel & args)

Fired when the data in ui::Clipboard is changed.

Events will be put on the |channel| with signature [::on-clipboard-data-changed []].

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

update-printer clj/s macro

(update-printer printer)

Update printer. Printer with empty ID is considered new.

|printer| - ?

update-printer* cljs

(update-printer* config printer)

wait-for-ambient-photo-animation clj/s macro

(wait-for-ambient-photo-animation photo-refresh-interval
                                  num-completions
                                  timeout)

Waits for the completion of photo transition animation in ambient mode.

|photo-refresh-interval| - photo refresh interval in seconds. |num-completions| - number of completions of the animation. |timeout| - the timeout in seconds.

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.

wait-for-ambient-photo-animation* cljs

(wait-for-ambient-photo-animation* config
                                   photo-refresh-interval
                                   num-completions
                                   timeout)

wait-for-assistant-query-status clj/s macro

(wait-for-assistant-query-status timeout-s)

Invokes |callback| once the current text/voice interaction is completed. Responds with the the query status if any valid response was caught before the timeout. This API should be called before sending the query. To use it for testing a voice query via OKG in Autotest, for example, you can do:// Enable hotword setting for Assistant. assistant_util.enable_hotword();// Call this API with your callback function. chrome.autotestPrivate.waitForAssistantQueryStatus(timeout_s, function(status) {...});then start Assistant via OKG and send voice query before timeout.TODO(meilinw@): disable warmer welcome to avoid an unintended early return of this API when launching Assistant via hotkey. TODO(meilinw@): update the comment above to use Tast instead after adding API to enable hotword in Tast.

|timeout-s| - ?

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

|status| - ?

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.

wait-for-assistant-query-status* cljs

(wait-for-assistant-query-status* config timeout-s)

wait-for-display-rotation clj/s macro

(wait-for-display-rotation display-id rotation)

Invokes the callback when the display rotation animation is finished, or invokes it immediately if it is not animating. The callback argument is true if the display's rotation is same as |rotation|, or false otherwise.

|display-id| - display that contains the shelf. |rotation| - the target rotation.

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.

wait-for-display-rotation* cljs

(wait-for-display-rotation* config display-id rotation)

wait-for-launcher-state clj/s macro

(wait-for-launcher-state launcher-state)

Wwait until the launcher is transitionto the |launcherState|, if it's not in that state.

|launcher-state| - the target launcher state.

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.

wait-for-launcher-state* cljs

(wait-for-launcher-state* config launcher-state)

wait-for-overview-state clj/s macro

(wait-for-overview-state overview-state)

Wait until overview has transitioned to |overviewState|, if it is not in that state.

|overview-state| - the target overview state.

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.

wait-for-overview-state* cljs

(wait-for-overview-state* config overview-state)

wait-for-system-web-apps-install clj/s macro

(wait-for-system-web-apps-install)

Waits for system web apps to complete the installation.

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.

wait-for-system-web-apps-install* cljs

(wait-for-system-web-apps-install* config)