input.performActions Befehl

Syntax

{
  "method": "input.performActions",
  "params": {
    "context": "<contextId>",
    "actions": [
      {
        "type": "<outerType>",
        "id": "<sourceId>",
        "actions": [
          {
            "type": "<innerType>",
            ...
          }
        ]
      }
    ]
  }
}

Parameter

Das params-Feld enthält:

context

Eine Zeichenkette, die die ID (UUID) des Kontexts enthält, in dem die Aktionen ausgeführt werden sollen. Kontext-IDs werden von Befehlen wie browsingContext.getTree zurückgegeben.

actions

Ein Array von Objekten, von denen jedes eine Eingabequelle und die für diese Quelle auszuführenden Aktionen darstellt. Jedes solche Objekt stellt das äußere actions-Objekt dar, das wiederum einen äußeren type (Eingabequellentyp kann "key", "pointer" oder "wheel" sein) und ein inneres actions-Array enthält. Jedes Objekt im inneren actions-Array hat seinen eigenen inneren type und zusätzliche Felder, die davon abhängen.

Alle Eingabequellen werden parallel verarbeitet. In jedem Tick (Schritt) führt jede Eingabequelle eine Aktion gleichzeitig aus oder tut nichts, wenn eine "pause"-Aktion zugewiesen ist. Dies ermöglicht das Kombinieren von Eingabequellen, z.B. das Halten der Umschalttaste, während geklickt wird.

Jedes äußere actions-Objekt hat die folgenden Felder:

id

Eine Zeichenkette, die diese Eingabequelle innerhalb der Aktionssequenz eindeutig identifiziert, z.B. "mouse1" oder "keyboard1".

type

Eine Zeichenkette (der äußere type), die den Typ der Eingabequelle identifiziert. Akzeptierte Werte sind "none", "key", "pointer" und "wheel".

actions

Ein Array von Objekten (die inneren actions), von denen jedes eine Aktion für die im äußeren type Feld spezifizierte Eingabequelle darstellt.

Jedes innere actions-Objekt hat ein inneres type-Feld, das die auszuführende Operation und zusätzliche Felder spezifiziert, die davon abhängen. Der innere type akzeptiert die folgenden Werte:

• "pause": Wartet für die angegebene Dauer, bevor zum nächsten Schritt übergegangen wird.
• "keyDown": Simuliert das Drücken einer Taste.
• "keyUp": Simuliert das Loslassen einer Taste.
• "pointerDown": Simuliert das Drücken einer Zeigertaste.
• "pointerUp": Simuliert das Loslassen einer Zeigertaste.
• "pointerMove": Simuliert das Bewegen des Zeigers.
• "scroll": Simuliert ein Scrollen mit dem Mausrad.

Die folgende Tabelle zeigt, für jeden äußeren type-Wert, die gültigen Werte für den inneren type:

Äußere type-Werte	Akzeptierte innere type-Werte
"none"	"pause"
"key"	"pause", "keyDown", "keyUp"
"pointer"	"pause", "pointerDown", "pointerUp", "pointerMove"
"wheel"	"pause", "scroll"

Die folgende Tabelle zeigt, für jeden inneren type-Wert, die verfügbaren Felder im inneren actions-Objekt:

Innere type-Werte	Verfügbare Felder im inneren actions-Objekt
"pause"	duration
"keyDown", "keyUp"	value
"pointerDown"	button, Zeigereigenschaften
"pointerUp"	button
"pointerMove"	x, y, duration, origin, Zeigereigenschaften
"scroll"	x, y, deltaX, deltaY, duration, origin

Das äußere actions-Objekt unterstützt auch das folgende Feld:

parameters Optional

Ein Objekt mit einem pointerType-Feld, das den Gerätetyp des Zeigers angibt. Akzeptierte Werte sind "mouse" (Standard), "pen" oder "touch". Dieses Feld ist nur gültig, wenn der äußere type "pointer" ist.

Die folgenden Felder sind in jedem inneren actions-Objekt verfügbar, abhängig von dem inneren type:

button

Eine nicht-negative ganze Zahl, die die Zeigertaste identifiziert (0 = primär, 1 = mittig, 2 = sekundär). Geben Sie dies an, wenn der innere type-Feldwert "pointerDown" oder "pointerUp" ist.

deltaX

Eine ganze Zahl, die das horizontale Scroll-Delta in CSS-Pixel angibt. Geben Sie dies an, wenn der innere type-Feldwert "scroll" ist.

deltaY

Eine ganze Zahl, die das vertikale Scroll-Delta in CSS-Pixel angibt. Geben Sie dies an, wenn der innere type-Feldwert "scroll" ist.

duration Optional

Eine nicht-negative ganze Zahl, die die Zeit in Millisekunden angibt, über die die Aktion ausgeführt wird. Geben Sie dies an, wenn der innere type-Feldwert "pause", "pointerMove" oder "scroll" ist. Bei "pointerMove" und "scroll" erfolgt die gesamte Bewegung als eine Reihe kleiner Bewegungen über diesen Zeitraum in einer vom Browser definierten Rate (zum Beispiel ein Schritt pro Animationsbild). Wenn mehrere äußere actions-Objekte parallel laufen, dauert der Tick so lange wie der längste duration-Wert in diesem Tick.

origin Optional

Eine Zeichenkette oder ein Objekt, das den Ursprung für die Bewegung oder das Scrollen angibt. Geben Sie dies an, wenn der innere type-Feldwert "pointerMove" oder "scroll" ist.

Wenn origin eine Zeichenkette ist, werden folgende Werte akzeptiert:

• "viewport": Gibt an, dass die x- und y-Koordinaten relativ zur oberen linken Ecke des Ansichtsfensters sind. Verwenden Sie dies zur absoluten Positionierung innerhalb der Seite. Dies ist der Standardwert für "scroll", wenn origin ausgelassen wird.
• "pointer": Gibt an, dass die x- und y-Koordinaten relativ zur aktuellen Zeigerposition sind. Verwenden Sie dies für relative Bewegungen von der aktuellen Position der Zeiger.

Wenn origin ein Objekt ist, enthalten Sie die folgenden Felder:

type

Eine Zeichenkette, gesetzt auf "element".

element

Ein Objekt, das die ID enthält, die das DOM-Element eindeutig identifiziert, das als Ursprung verwendet werden soll. Die ID wird vom Browser zurückgegeben, wenn Sie das Element mit browsingContext.locateNodes, script.evaluate oder script.callFunction lokalisieren.

value

Eine Zeichenkette, die den Tastenwert enthält. Geben Sie dies an, wenn der innere type-Feldwert "keyDown" oder "keyUp" ist. Für Sondertasten wie Shift oder Enter verwenden Sie die in der WebDriver-Tastatureingaben Tabelle definierten Unicode-Codepunkte (zum Beispiel "\uE008" für die Shift-Taste). Für druckbare Zeichen verwenden Sie das Zeichen direkt (zum Beispiel "a").

Zeigereigenschaften

Die folgenden Felder sind Teil des inneren actions-Objekts und beschreiben die physikalischen Eigenschaften des Zeigegeräts, wie Maus, Stift oder Touchscreen. Geben Sie diese an, wenn der innere type "pointerDown" oder "pointerMove" ist.

width Optional

Eine nicht-negative ganze Zahl, die die Breite in CSS-Pixel des Zeigerkontaktbereichs angibt. Siehe PointerEvent.width.

height Optional

Eine nicht-negative ganze Zahl, die die Höhe in CSS-Pixel des Zeigerkontaktbereichs angibt. Siehe PointerEvent.height.

pressure Optional

Eine Fließkommazahl, die den normalisierten Druck des Zeigers im Bereich 0.0–1.0 angibt. Siehe PointerEvent.pressure.

tangentialPressure Optional

Eine Fließkommazahl, die den normalisierten Tangentialdruck im Bereich -1.0–1.0 angibt. Siehe PointerEvent.tangentialPressure.

twist Optional

Eine ganze Zahl, die die Drehung im Uhrzeigersinn in Grad des Zeigers im Bereich 0–359 angibt. Siehe PointerEvent.twist.

altitudeAngle Optional

Eine Fließkommazahl, die den Höhenwinkel in Radiant des Zeigers im Bereich 0.0–π/2 angibt. Siehe PointerEvent.altitudeAngle.

azimuthAngle Optional

Eine Fließkommazahl, die den Azimutwinkel in Radiant des Zeigers im Bereich 0.0–2π angibt. Siehe PointerEvent.azimuthAngle.

x

Eine Zahl (für "pointerMove") oder eine ganze Zahl (für "scroll"), die die x-Koordinate angibt. Geben Sie dies an, wenn der innere type-Feldwert "pointerMove" oder "scroll" ist.

y

Eine Zahl (für "pointerMove") oder eine ganze Zahl (für "scroll"), die die y-Koordinate angibt. Geben Sie dies an, wenn der innere type-Feldwert "pointerMove" oder "scroll" ist.

Rückgabewert

Das result-Feld in der Antwort ist ein leeres Objekt ({}).

Fehler

invalid argument

Die Aktionssequenz ist fehlerhaft; z.B. wenn ein erforderliches Feld fehlt, ein Feldwert vom falschen Typ ist oder ein äußerer type-Wert nicht "none", "key", "pointer" oder "wheel" ist.

no such frame

Kein Kontext mit der angegebenen Kontext-ID gefunden.

Beispiele

Halten der Umschalttaste während des Klicks auf ein Element

Betrachten Sie ein Szenario, in dem Sie die Umschalttaste gedrückt halten möchten, während Sie auf ein Element klicken, um beispielsweise eine Textauswahl zu erweitern.

Mit einer WebDriver BiDi Verbindung und einer aktiven Sitzung erhalten Sie die Kontext-ID mit browsingContext.getTree und die Element-ID mit browsingContext.locateNodes. Senden Sie die folgende Nachricht mit zwei äußeren actions-Objekten — eine "key"-Quelle und eine "pointer"-Quelle — jede mit einem äußeren type und einem inneren actions-Array, die parallel über die folgenden drei Ticks ausgeführt werden:

• Tick 1: Die Tastatur drückt Umschalttaste während der Zeiger zum Element bewegt wird. Da die duration von pointerMove als 300 angegeben ist, dauert der Tick 300 ms, was die längste duration in diesem Tick ist.
• Tick 2: Die Tastatur pausiert, während die Zeigertaste gedrückt wird (pointerDown). Dieser Tick dauert 0 ms.
• Tick 3: Die Umschalttaste wird losgelassen (keyUp) und die Zeigertaste wird gleichzeitig losgelassen (pointerUp). Auch dieser Tick dauert 0 ms.

{
  "id": 1,
  "method": "input.performActions",
  "params": {
    "context": "5f07e3ca-ecac-465e-b9ef-49000c196ecf",
    "actions": [
      {
        "type": "key",
        "id": "keyboard1",
        "actions": [
          {
            "type": "keyDown", // Tick 1: Shift key down (0 ms)
            "value": "\uE008"
          },
          {
            "type": "pause" // Tick 2: Keyboard pause (0 ms)
          },
          {
            "type": "keyUp", // Tick 3: Shift key up (0 ms)
            "value": "\uE008"
          }
        ]
      },
      {
        "type": "pointer",
        "id": "mouse1",
        "parameters": {
          "pointerType": "mouse"
        },
        "actions": [
          {
            "type": "pointerMove", // Tick 1: Move to element (300 ms)
            "x": 0,
            "y": 0,
            "duration": 300,
            "origin": {
              "type": "element",
              "element": {
                "sharedId": "3be28343-afd3-4dea-a2b6-a863fbbb80e1"
              }
            }
          },
          {
            "type": "pointerDown", // Tick 2: Press button (0 ms)
            "button": 0
          },
          {
            "type": "pointerUp", // Tick 3: Release button (0 ms)
            "button": 0
          }
        ]
      }
    ]
  }
}

Der Browser antwortet wie folgt:

{
  "id": 1,
  "type": "success",
  "result": {}
}

Scrollen der Seite

Betrachten Sie ein Szenario, in dem Sie das Scrollen einer Seite nach unten simulieren möchten.

Mit einer WebDriver BiDi Verbindung und einer aktiven Sitzung erhalten Sie die Kontext-ID mit browsingContext.getTree. Senden Sie die folgende Nachricht, die vom oberen linken Bereich des Ansichtsfensters (x: 0, y: 0) um 300 CSS-Pixel nach unten scrollt (deltaY: 300) ohne horizontales Scrollen (deltaX: 0).

{
  "id": 2,
  "method": "input.performActions",
  "params": {
    "context": "5f07e3ca-ecac-465e-b9ef-49000c196ecf",
    "actions": [
      {
        "type": "wheel",
        "id": "wheel1",
        "actions": [
          {
            "type": "scroll",
            "x": 0,
            "y": 0,
            "deltaX": 0,
            "deltaY": 300
          }
        ]
      }
    ]
  }
}

Der Browser antwortet wie folgt:

{
  "id": 2,
  "type": "success",
  "result": {}
}

Spezifikationen

Browser-Kompatibilität

Siehe auch

• input.releaseActions Befehl
• input.setFiles Befehl
• input.fileDialogOpened Ereignis