Exec.2.1

The Opera Exec protocol can be used to control an Opera instance from the outside, and various operations can be initiated. This functionality is mainly useful for QA testing.

Examples

The following example will do a spatial navigation down:

.. code-block:: javascript

Exec([ [ ["_keydown","shift"], ["_keydown","down"], ["_keyup","down"], ["_keyup","shift"] ] ])

The following will type the text "Hello":

.. code-block:: javascript

Exec([ [ ["_type","Hello"] ] ])

Take note that shift-modifier key-presses are neither generated nor taken into account when processing the letters of the _type operation. This means that no shift key will be pressed around the "H" in "Hello" above, and the text typed would still be "Hello" if the shift key was pressed (with a _keydown operation) before the _type operation.

The following will trigger an Action of "Page down":

.. code-block:: javascript

Exec([ [ ["Page Down"] ] ])

Error handling

There are currently no error messages or other reports of a failed operation. Incorrect syntax, unknown keys, or other invalid input will be silently dropped.

Exec

Executes a series of actions in the opera host, each action consists of a name identifying the action and optionally a value for the action. The value depends on the type of action.

command Exec(ActionList)

```
 repeated Action actionList = 1;
```
```
{
```
- ```
required string name = 1;
```
  The name of the action to execute. This is either a regular Opera action (e.g. "Page Down"), or a special exec-action. Both kinds can be found by calling GetActionInfoList. The special cases are prefixed with underscore ("_"), and these require value parameter to work, but always ignores windowID.
  
  The special cases may include: _keydown | _keyup: The value is either a key-name ("ctrl", "down", etc.) or a single character ("a", "b", etc.) _type: Types the text present in value (a different approach is the "Insert" action)
  
  It is currently not possible to figure out which actions take parameters (value), and which don't. Optimistically, we have made the Action type extendable to include such information later.
- ```
optional string value = 2;
```
  String parameter for extra string data to be sent with the action E.g. "opera.com" to the command "go"
- ```
optional uint32 windowID = 3;
```
  Window to send the action to, 0 for the currently active window
  
  WARNING: Please be sure you want this is you use it as you might not actually know the correct window and then the action will fail. 0 is best if you are unsure
- ```
optional int32 data = 4;
```
  Data parameter for extra integer data to be sent with the action
  
  In some actions the data parameter is interpreted as a pointer rather than an integer. In these cases the action will fail.
- ```
optional string stringParam = 5;
```
  Extra string parameter for action, sent in addition to the 'value' parameter for actions that need two strings
```
}
```

returns (Default)

= 1;

GetActionInfoList

Request a list of valid actions.

command GetActionInfoList(Default)

returns (ActionInfoList)

List all valid Action names

 repeated ActionInfo actionInfoList = 1;

Name of an action, to be used in the Action message.
```
required string name = 1;
```

= 2;

SendMouseAction

Move mouse to the given position on the screen/window. Note that the mouse cursor is not moved visibly.

The coordinates are relative to the upper left corner of the tab (not including chrome).

command SendMouseAction(MouseAction)

```
required uint32 windowID = 1;
```
```
required int32 x = 2;
```
```
required int32 y = 3;
```
```
required uint32 buttonAction = 4;
```
buttonAction specifies the buttons to press or release It is specifies as the sum of button actions: 1 - Button 1 down 2 - Button 1 up
4 - Button 2 down 8 - Button 2 up 16 - Button 3 down 32 - Button 3 up
For example, to press button 1 and release button 2, the value is 9 (1+8)

Buttons are clicked in the sequence listed above. Note that down actions are listed before up actions, thus allowing single-clicking with one command (e.g. using value 3)

returns (Default)

= 5;

SetupScreenWatcher

command SetupScreenWatcher(ScreenWatcher)

```
required uint32 timeOut = 1 [default = 10000];
```
Number of milliseconds to wait before capturing the screen area.

The default is 10 seconds.

 required Area area = 2;

Define an area on the page, relative to the page (not viewport).

The default area is {x=0, y=0, w=200, h=100}.

```
required int32 x = 1;
```
```
required int32 y = 2;
```
```
required int32 w = 3;
```
```
required int32 h = 4;
```

```
repeated string md5List = 3;
```
MD5 sum of an image, in hexadecimal.
```
optional uint32 windowID = 4 [default = 0];
```
The ID of the window to watch, the default (or 0) is to watch the current window
```
 repeated ColorSpec colorSpecList = 5;
```
```
{
```
- Specifies a new color specification. The id is used when reporting back the results. You can have overlapping color specifications. Note: There can be a maximum of 16 color specifications!
  
  Color values ranges from 0 (no color) to 255 (maximal saturation), other values are not allowed. Default (meaning field missing) is 0 for any low fields and 255 for any high fields.
- ```
required uint32 id = 1;
```
- ```
optional uint32 redLow = 2 [default = 0];
```
- ```
optional uint32 redHigh = 3 [default = 255];
```
- ```
optional uint32 greenLow = 4 [default = 0];
```
- ```
optional uint32 greenHigh = 5 [default = 255];
```
- ```
optional uint32 blueLow = 6 [default = 0];
```
- ```
optional uint32 blueHigh = 7 [default = 255];
```
```
}
```
```
optional bool includeImage = 6 [default = true];
```
If true then the image data will be sent in the response WatcherResult.png, otherwise the field will be omitted Can be used to reduce bandwith usage in applications where only hashes are needed.

returns (ScreenWatcherResult)

```
required uint32 windowID = 1;
```
The ID of the window that was triggered by a screen watch, or 0 if the screen watch failed or was cancelled
```
required string md5 = 2;
```
MD5 sum of an image, in hexadecimal.
```
optional bytes png = 3;
```

 repeated ColorMatch colorMatchList = 4;

```
required uint32 id = 1;
```
The ColorSpec.id which matched a color
```
required uint32 count = 2;
```
Number of pixels for the matching id

= 3;

Exec2.1

Commands

Events

Examples

Error handling

Exec

GetActionInfoList

SendMouseAction

SetupScreenWatcher