@wdio/protocols
Version:
Utility package providing information about automation protocols
848 lines • 71.3 kB
TypeScript
/**
* !!! PLEASE DO NOT EDIT THIS FILE !!!
*
* This source file, even though checked in, is auto-generated based on the
* current development within the WebDriver Bidi spec. Any changes to this
* file need to come from the specification. You can generate this file by calling
*
* ```
* $ npm run generate:bidi
* ```
*
* from the project root. You can find the scripts that generates this file in
* ./scripts/bidi/**
*/
declare const protocol: {
readonly sendCommand: {
readonly socket: {
readonly command: "send";
readonly description: "Send socket commands via WebDriver Bidi";
readonly ref: "https://github.com/w3c/webdriver-bidi";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "CommandData";
readonly description: "socket payload";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "CommandResponse";
readonly description: "WebDriver Bidi response";
};
};
};
readonly sendAsyncCommand: {
readonly socket: {
readonly command: "sendAsync";
readonly description: "Send asynchronous socket commands via WebDriver Bidi";
readonly ref: "https://github.com/w3c/webdriver-bidi";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "CommandData";
readonly description: "socket payload";
readonly required: true;
}];
readonly returns: {
readonly type: "Number";
readonly name: "id";
readonly description: "id of WebDriver Bidi request";
};
};
};
readonly "session.status": {
readonly socket: {
readonly command: "sessionStatus";
readonly description: "WebDriver Bidi command to send command method \"session.status\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-session-status";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.EmptyParams`";
readonly description: "<pre>\\{\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.SessionStatusResult";
readonly description: "Command return value with the following interface:\n ```ts\n {\n ready: boolean;\n message: string;\n }\n ```";
};
};
};
readonly "session.new": {
readonly socket: {
readonly command: "sessionNew";
readonly description: "WebDriver Bidi command to send command method \"session.new\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-session-new";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.SessionNewParameters`";
readonly description: "<pre>\\{<br /> capabilities: SessionCapabilitiesRequest;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.SessionNewResult";
readonly description: "Command return value with the following interface:\n ```ts\n {\n sessionId: string;\n capabilities: {\n acceptInsecureCerts: boolean;\n browserName: string;\n browserVersion: string;\n platformName: string;\n setWindowRect: boolean;\n userAgent: string;\n proxy?: SessionProxyConfiguration;\n unhandledPromptBehavior?: SessionUserPromptHandler;\n webSocketUrl?: string;\n };\n }\n ```";
};
};
};
readonly "session.end": {
readonly socket: {
readonly command: "sessionEnd";
readonly description: "WebDriver Bidi command to send command method \"session.end\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-session-end";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.EmptyParams`";
readonly description: "<pre>\\{\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.SessionEndResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "session.subscribe": {
readonly socket: {
readonly command: "sessionSubscribe";
readonly description: "WebDriver Bidi command to send command method \"session.subscribe\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-session-subscribe";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.SessionSubscribeParameters`";
readonly description: "<pre>\\{<br /> events: string[];<br /> contexts?: BrowsingContextBrowsingContext[];<br /> userContexts?: BrowserUserContext[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.SessionSubscribeResult";
readonly description: "Command return value with the following interface:\n ```ts\n {\n subscription: SessionSubscription;\n }\n ```";
};
};
};
readonly "session.unsubscribe": {
readonly socket: {
readonly command: "sessionUnsubscribe";
readonly description: "WebDriver Bidi command to send command method \"session.unsubscribe\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-session-unsubscribe";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.SessionUnsubscribeParameters`";
readonly description: "<pre>\\{\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.SessionUnsubscribeResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "browser.close": {
readonly socket: {
readonly command: "browserClose";
readonly description: "WebDriver Bidi command to send command method \"browser.close\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browser-close";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.EmptyParams`";
readonly description: "<pre>\\{\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowserCloseResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "browser.createUserContext": {
readonly socket: {
readonly command: "browserCreateUserContext";
readonly description: "WebDriver Bidi command to send command method \"browser.createUserContext\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browser-createUserContext";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowserCreateUserContextParameters`";
readonly description: "<pre>\\{<br /> acceptInsecureCerts?: boolean;<br /> proxy?: SessionProxyConfiguration;<br /> unhandledPromptBehavior?: SessionUserPromptHandler;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowserCreateUserContextResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "browser.getClientWindows": {
readonly socket: {
readonly command: "browserGetClientWindows";
readonly description: "WebDriver Bidi command to send command method \"browser.getClientWindows\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browser-getClientWindows";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.EmptyParams`";
readonly description: "<pre>\\{\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowserGetClientWindowsResult";
readonly description: "Command return value with the following interface:\n ```ts\n {\n clientWindows: BrowserClientWindowInfo[];\n }\n ```";
};
};
};
readonly "browser.getUserContexts": {
readonly socket: {
readonly command: "browserGetUserContexts";
readonly description: "WebDriver Bidi command to send command method \"browser.getUserContexts\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browser-getUserContexts";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.EmptyParams`";
readonly description: "<pre>\\{\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowserGetUserContextsResult";
readonly description: "Command return value with the following interface:\n ```ts\n {\n userContexts: BrowserUserContextInfo[];\n }\n ```";
};
};
};
readonly "browser.removeUserContext": {
readonly socket: {
readonly command: "browserRemoveUserContext";
readonly description: "WebDriver Bidi command to send command method \"browser.removeUserContext\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browser-removeUserContext";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowserRemoveUserContextParameters`";
readonly description: "<pre>\\{<br /> userContext: BrowserUserContext;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowserRemoveUserContextResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "browser.setClientWindowState": {
readonly socket: {
readonly command: "browserSetClientWindowState";
readonly description: "WebDriver Bidi command to send command method \"browser.setClientWindowState\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browser-setClientWindowState";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowserSetClientWindowStateParameters`";
readonly description: "<pre>\\{<br /> clientWindow: BrowserClientWindow;<br />\\};</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowserSetClientWindowStateResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "browser.setDownloadBehavior": {
readonly socket: {
readonly command: "browserSetDownloadBehavior";
readonly description: "WebDriver Bidi command to send command method \"browser.setDownloadBehavior\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browser-setDownloadBehavior";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowserSetDownloadBehaviorParameters`";
readonly description: "<pre>\\{<br /> downloadBehavior: BrowserDownloadBehavior | null;<br /> userContexts?: BrowserUserContext[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowserSetDownloadBehaviorResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "browsingContext.activate": {
readonly socket: {
readonly command: "browsingContextActivate";
readonly description: "WebDriver Bidi command to send command method \"browsingContext.activate\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browsingContext-activate";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowsingContextActivateParameters`";
readonly description: "<pre>\\{<br /> context: BrowsingContextBrowsingContext;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowsingContextActivateResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "browsingContext.captureScreenshot": {
readonly socket: {
readonly command: "browsingContextCaptureScreenshot";
readonly description: "WebDriver Bidi command to send command method \"browsingContext.captureScreenshot\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browsingContext-captureScreenshot";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowsingContextCaptureScreenshotParameters`";
readonly description: "<pre>\\{<br /> context: BrowsingContextBrowsingContext;<br /> /\\*\\*<br /> \\* @default 'viewport'<br /> \\*/<br /> origin?: \"viewport\" | \"document\";<br /> format?: BrowsingContextImageFormat;<br /> clip?: BrowsingContextClipRectangle;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowsingContextCaptureScreenshotResult";
readonly description: "Command return value with the following interface:\n ```ts\n {\n data: string;\n }\n ```";
};
};
};
readonly "browsingContext.close": {
readonly socket: {
readonly command: "browsingContextClose";
readonly description: "WebDriver Bidi command to send command method \"browsingContext.close\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browsingContext-close";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowsingContextCloseParameters`";
readonly description: "<pre>\\{<br /> context: BrowsingContextBrowsingContext;<br /> promptUnload?: boolean;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowsingContextCloseResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "browsingContext.create": {
readonly socket: {
readonly command: "browsingContextCreate";
readonly description: "WebDriver Bidi command to send command method \"browsingContext.create\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browsingContext-create";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowsingContextCreateParameters`";
readonly description: "<pre>\\{<br /> type: BrowsingContextCreateType;<br /> referenceContext?: BrowsingContextBrowsingContext;<br /> background?: boolean;<br /> userContext?: BrowserUserContext;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowsingContextCreateResult";
readonly description: "Command return value with the following interface:\n ```ts\n {\n context: BrowsingContextBrowsingContext;\n userContext?: BrowserUserContext;\n }\n ```";
};
};
};
readonly "browsingContext.getTree": {
readonly socket: {
readonly command: "browsingContextGetTree";
readonly description: "WebDriver Bidi command to send command method \"browsingContext.getTree\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browsingContext-getTree";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowsingContextGetTreeParameters`";
readonly description: "<pre>\\{<br /> maxDepth?: JsUint;<br /> root?: BrowsingContextBrowsingContext;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowsingContextGetTreeResult";
readonly description: "Command return value with the following interface:\n ```ts\n {\n contexts: BrowsingContextInfoList;\n }\n ```";
};
};
};
readonly "browsingContext.handleUserPrompt": {
readonly socket: {
readonly command: "browsingContextHandleUserPrompt";
readonly description: "WebDriver Bidi command to send command method \"browsingContext.handleUserPrompt\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browsingContext-handleUserPrompt";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowsingContextHandleUserPromptParameters`";
readonly description: "<pre>\\{<br /> context: BrowsingContextBrowsingContext;<br /> accept?: boolean;<br /> userText?: string;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowsingContextHandleUserPromptResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "browsingContext.locateNodes": {
readonly socket: {
readonly command: "browsingContextLocateNodes";
readonly description: "WebDriver Bidi command to send command method \"browsingContext.locateNodes\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browsingContext-locateNodes";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowsingContextLocateNodesParameters`";
readonly description: "<pre>\\{<br /> context: BrowsingContextBrowsingContext;<br /> locator: BrowsingContextLocator;<br /> maxNodeCount?: JsUint;<br /> serializationOptions?: ScriptSerializationOptions;<br /> startNodes?: ScriptSharedReference[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowsingContextLocateNodesResult";
readonly description: "Command return value with the following interface:\n ```ts\n {\n nodes: ScriptNodeRemoteValue[];\n }\n ```";
};
};
};
readonly "browsingContext.navigate": {
readonly socket: {
readonly command: "browsingContextNavigate";
readonly description: "WebDriver Bidi command to send command method \"browsingContext.navigate\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browsingContext-navigate";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowsingContextNavigateParameters`";
readonly description: "<pre>\\{<br /> context: BrowsingContextBrowsingContext;<br /> url: string;<br /> wait?: BrowsingContextReadinessState;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowsingContextNavigateResult";
readonly description: "Command return value with the following interface:\n ```ts\n {\n navigation: BrowsingContextNavigation | null;\n url: string;\n }\n ```";
};
};
};
readonly "browsingContext.print": {
readonly socket: {
readonly command: "browsingContextPrint";
readonly description: "WebDriver Bidi command to send command method \"browsingContext.print\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browsingContext-print";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowsingContextPrintParameters`";
readonly description: "<pre>\\{<br /> context: BrowsingContextBrowsingContext;<br /> background?: boolean;<br /> margin?: BrowsingContextPrintMarginParameters;<br /> /\\*\\*<br /> \\* @default 'portrait'<br /> \\*/<br /> orientation?: \"portrait\" | \"landscape\";<br /> page?: BrowsingContextPrintPageParameters;<br /> pageRanges?: (JsUint | string)[];<br /> /\\*\\*<br /> \\* @default 1<br /> \\*/<br /> scale?: number;<br /> /\\*\\*<br /> \\* @default true<br /> \\*/<br /> shrinkToFit?: boolean;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowsingContextPrintResult";
readonly description: "Command return value with the following interface:\n ```ts\n {\n data: string;\n }\n ```";
};
};
};
readonly "browsingContext.reload": {
readonly socket: {
readonly command: "browsingContextReload";
readonly description: "WebDriver Bidi command to send command method \"browsingContext.reload\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browsingContext-reload";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowsingContextReloadParameters`";
readonly description: "<pre>\\{<br /> context: BrowsingContextBrowsingContext;<br /> ignoreCache?: boolean;<br /> wait?: BrowsingContextReadinessState;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowsingContextReloadResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "browsingContext.setBypassCSP": {
readonly socket: {
readonly command: "browsingContextSetBypassCsp";
readonly description: "WebDriver Bidi command to send command method \"browsingContext.setBypassCSP\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browsingContext-setBypassCSP";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowsingContextSetBypassCspParameters`";
readonly description: "<pre>\\{<br /> bypass: true | null;<br /> contexts?: BrowsingContextBrowsingContext[];<br /> userContexts?: BrowserUserContext[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowsingContextSetBypassCspResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "browsingContext.setViewport": {
readonly socket: {
readonly command: "browsingContextSetViewport";
readonly description: "WebDriver Bidi command to send command method \"browsingContext.setViewport\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browsingContext-setViewport";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowsingContextSetViewportParameters`";
readonly description: "<pre>\\{<br /> context?: BrowsingContextBrowsingContext;<br /> viewport?: BrowsingContextViewport | null;<br /> devicePixelRatio?: number | null;<br /> userContexts?: BrowserUserContext[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowsingContextSetViewportResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "browsingContext.startScreencast": {
readonly socket: {
readonly command: "browsingContextStartScreencast";
readonly description: "WebDriver Bidi command to send command method \"browsingContext.startScreencast\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browsingContext-startScreencast";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowsingContextStartScreencastParameters`";
readonly description: "<pre>\\{<br /> context: BrowsingContextBrowsingContext;<br /> mimeType?: string;<br /> video?: BrowsingContextMediaTrackConstraints;<br /> audio?: boolean;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowsingContextStartScreencastResult";
readonly description: "Command return value with the following interface:\n ```ts\n {\n screencast: BrowsingContextScreencast;\n path: string;\n }\n ```";
};
};
};
readonly "browsingContext.stopScreencast": {
readonly socket: {
readonly command: "browsingContextStopScreencast";
readonly description: "WebDriver Bidi command to send command method \"browsingContext.stopScreencast\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browsingContext-stopScreencast";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowsingContextStopScreencastParameters`";
readonly description: "<pre>\\{<br /> screencast: BrowsingContextScreencast;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowsingContextStopScreencastResult";
readonly description: "Command return value with the following interface:\n ```ts\n {\n path: string;\n error?: string;\n }\n ```";
};
};
};
readonly "browsingContext.traverseHistory": {
readonly socket: {
readonly command: "browsingContextTraverseHistory";
readonly description: "WebDriver Bidi command to send command method \"browsingContext.traverseHistory\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-browsingContext-traverseHistory";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.BrowsingContextTraverseHistoryParameters`";
readonly description: "<pre>\\{<br /> context: BrowsingContextBrowsingContext;<br /> delta: JsInt;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.BrowsingContextTraverseHistoryResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "emulation.setForcedColorsModeThemeOverride": {
readonly socket: {
readonly command: "emulationSetForcedColorsModeThemeOverride";
readonly description: "WebDriver Bidi command to send command method \"emulation.setForcedColorsModeThemeOverride\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-emulation-setForcedColorsModeThemeOverride";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.EmulationSetForcedColorsModeThemeOverrideParameters`";
readonly description: "<pre>\\{<br /> theme: EmulationForcedColorsModeTheme | null;<br /> contexts?: BrowsingContextBrowsingContext[];<br /> userContexts?: BrowserUserContext[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.EmulationSetForcedColorsModeThemeOverrideResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "emulation.setGeolocationOverride": {
readonly socket: {
readonly command: "emulationSetGeolocationOverride";
readonly description: "WebDriver Bidi command to send command method \"emulation.setGeolocationOverride\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-emulation-setGeolocationOverride";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.EmulationSetGeolocationOverrideParameters`";
readonly description: "<pre>\\{<br /> coordinates: EmulationGeolocationCoordinates | null;<br />\\} | \\{<br /> error: EmulationGeolocationPositionError;<br />\\}) & \\{<br /> contexts?: BrowsingContextBrowsingContext[];<br /> userContexts?: BrowserUserContext[];<br />\\};</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.EmulationSetGeolocationOverrideResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "emulation.setLocaleOverride": {
readonly socket: {
readonly command: "emulationSetLocaleOverride";
readonly description: "WebDriver Bidi command to send command method \"emulation.setLocaleOverride\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-emulation-setLocaleOverride";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.EmulationSetLocaleOverrideParameters`";
readonly description: "<pre>\\{<br /> locale: string | null;<br /> contexts?: BrowsingContextBrowsingContext[];<br /> userContexts?: BrowserUserContext[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.EmulationSetLocaleOverrideResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "emulation.setNetworkConditions": {
readonly socket: {
readonly command: "emulationSetNetworkConditions";
readonly description: "WebDriver Bidi command to send command method \"emulation.setNetworkConditions\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-emulation-setNetworkConditions";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.EmulationSetNetworkConditionsParameters`";
readonly description: "<pre>\\{<br /> networkConditions: EmulationNetworkConditions | null;<br /> contexts?: BrowsingContextBrowsingContext[];<br /> userContexts?: BrowserUserContext[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.EmulationSetNetworkConditionsResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "emulation.setScreenSettingsOverride": {
readonly socket: {
readonly command: "emulationSetScreenSettingsOverride";
readonly description: "WebDriver Bidi command to send command method \"emulation.setScreenSettingsOverride\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-emulation-setScreenSettingsOverride";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.EmulationSetScreenSettingsOverrideParameters`";
readonly description: "<pre>\\{<br /> screenArea: EmulationScreenArea | null;<br /> contexts?: BrowsingContextBrowsingContext[];<br /> userContexts?: BrowserUserContext[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.EmulationSetScreenSettingsOverrideResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "emulation.setScreenOrientationOverride": {
readonly socket: {
readonly command: "emulationSetScreenOrientationOverride";
readonly description: "WebDriver Bidi command to send command method \"emulation.setScreenOrientationOverride\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-emulation-setScreenOrientationOverride";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.EmulationSetScreenOrientationOverrideParameters`";
readonly description: "<pre>\\{<br /> screenOrientation: EmulationScreenOrientation | null;<br /> contexts?: BrowsingContextBrowsingContext[];<br /> userContexts?: BrowserUserContext[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.EmulationSetScreenOrientationOverrideResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "emulation.setUserAgentOverride": {
readonly socket: {
readonly command: "emulationSetUserAgentOverride";
readonly description: "WebDriver Bidi command to send command method \"emulation.setUserAgentOverride\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-emulation-setUserAgentOverride";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.EmulationSetUserAgentOverrideParameters`";
readonly description: "<pre>\\{<br /> userAgent: string | null;<br /> contexts?: BrowsingContextBrowsingContext[];<br /> userContexts?: BrowserUserContext[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.EmulationSetUserAgentOverrideResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "emulation.setScriptingEnabled": {
readonly socket: {
readonly command: "emulationSetScriptingEnabled";
readonly description: "WebDriver Bidi command to send command method \"emulation.setScriptingEnabled\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-emulation-setScriptingEnabled";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.EmulationSetScriptingEnabledParameters`";
readonly description: "<pre>\\{<br /> enabled: false | null;<br /> contexts?: BrowsingContextBrowsingContext[];<br /> userContexts?: BrowserUserContext[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.EmulationSetScriptingEnabledResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "emulation.setScrollbarTypeOverride": {
readonly socket: {
readonly command: "emulationSetScrollbarTypeOverride";
readonly description: "WebDriver Bidi command to send command method \"emulation.setScrollbarTypeOverride\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-emulation-setScrollbarTypeOverride";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.EmulationSetScrollbarTypeOverrideParameters`";
readonly description: "<pre>\\{<br /> scrollbarType: \"classic\" | \"overlay\" | null;<br /> contexts?: BrowsingContextBrowsingContext[];<br /> userContexts?: BrowserUserContext[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.EmulationSetScrollbarTypeOverrideResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "emulation.setTimezoneOverride": {
readonly socket: {
readonly command: "emulationSetTimezoneOverride";
readonly description: "WebDriver Bidi command to send command method \"emulation.setTimezoneOverride\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-emulation-setTimezoneOverride";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.EmulationSetTimezoneOverrideParameters`";
readonly description: "<pre>\\{<br /> timezone: string | null;<br /> contexts?: BrowsingContextBrowsingContext[];<br /> userContexts?: BrowserUserContext[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.EmulationSetTimezoneOverrideResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "emulation.setTouchOverride": {
readonly socket: {
readonly command: "emulationSetTouchOverride";
readonly description: "WebDriver Bidi command to send command method \"emulation.setTouchOverride\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-emulation-setTouchOverride";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.EmulationSetTouchOverrideParameters`";
readonly description: "<pre>\\{<br /> maxTouchPoints: JsUint | null;<br /> contexts?: BrowsingContextBrowsingContext[];<br /> userContexts?: BrowserUserContext[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.EmulationSetTouchOverrideResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "network.addDataCollector": {
readonly socket: {
readonly command: "networkAddDataCollector";
readonly description: "WebDriver Bidi command to send command method \"network.addDataCollector\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-network-addDataCollector";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.NetworkAddDataCollectorParameters`";
readonly description: "<pre>\\{<br /> dataTypes: NetworkDataType[];<br /> maxEncodedDataSize: JsUint;<br /> /\\*\\*<br /> \\* @default 'blob'<br /> \\*/<br /> collectorType?: NetworkCollectorType;<br /> contexts?: BrowsingContextBrowsingContext[];<br /> userContexts?: BrowserUserContext[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.NetworkAddDataCollectorResult";
readonly description: "Command return value with the following interface:\n ```ts\n {\n collector: NetworkCollector;\n }\n ```";
};
};
};
readonly "network.addIntercept": {
readonly socket: {
readonly command: "networkAddIntercept";
readonly description: "WebDriver Bidi command to send command method \"network.addIntercept\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-network-addIntercept";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.NetworkAddInterceptParameters`";
readonly description: "<pre>\\{<br /> phases: NetworkInterceptPhase[];<br /> contexts?: BrowsingContextBrowsingContext[];<br /> urlPatterns?: NetworkUrlPattern[];<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.NetworkAddInterceptResult";
readonly description: "Command return value with the following interface:\n ```ts\n {\n intercept: NetworkIntercept;\n }\n ```";
};
};
};
readonly "network.continueRequest": {
readonly socket: {
readonly command: "networkContinueRequest";
readonly description: "WebDriver Bidi command to send command method \"network.continueRequest\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-network-continueRequest";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.NetworkContinueRequestParameters`";
readonly description: "<pre>\\{<br /> request: NetworkRequest;<br /> body?: NetworkBytesValue;<br /> cookies?: NetworkCookieHeader[];<br /> headers?: NetworkHeader[];<br /> method?: string;<br /> url?: string;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.NetworkContinueRequestResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "network.continueResponse": {
readonly socket: {
readonly command: "networkContinueResponse";
readonly description: "WebDriver Bidi command to send command method \"network.continueResponse\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-network-continueResponse";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.NetworkContinueResponseParameters`";
readonly description: "<pre>\\{<br /> request: NetworkRequest;<br /> cookies?: NetworkSetCookieHeader[];<br /> credentials?: NetworkAuthCredentials;<br /> headers?: NetworkHeader[];<br /> reasonPhrase?: string;<br /> statusCode?: JsUint;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.NetworkContinueResponseResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "network.continueWithAuth": {
readonly socket: {
readonly command: "networkContinueWithAuth";
readonly description: "WebDriver Bidi command to send command method \"network.continueWithAuth\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-network-continueWithAuth";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.NetworkContinueWithAuthParameters`";
readonly description: "<pre>\\{<br /> request: NetworkRequest;<br />\\};</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.NetworkContinueWithAuthResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "network.disownData": {
readonly socket: {
readonly command: "networkDisownData";
readonly description: "WebDriver Bidi command to send command method \"network.disownData\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#command-network-disownData";
readonly parameters: readonly [{
readonly name: "params";
readonly type: "`remote.NetworkDisownDataParameters`";
readonly description: "<pre>\\{<br /> dataType: NetworkDataType;<br /> collector: NetworkCollector;<br /> request: NetworkRequest;<br />\\}</pre>";
readonly required: true;
}];
readonly returns: {
readonly type: "Object";
readonly name: "local.NetworkDisownDataResult";
readonly description: "Command return value with the following interface:\n ```ts\n ;\n ```";
};
};
};
readonly "network.failRequest": {
readonly socket: {
readonly command: "networkFailRequest";
readonly description: "WebDriver Bidi command to send command method \"network.failRequest\" with parameters.";
readonly ref: "https://w3c.github.io/webdriver-bidi/#comman