跳至主要内容

WebDriver Bidi 协议

这些协议命令是根据当前有效的WebDriver Bidi规范生成的。要为您的测试启用该协议，请确保在您的功能中设置了webSocketUrl: true。

谨慎使用！

浏览器支持无法保证，并且接口将来可能会发生变化。该标准目前正在开发中，浏览器供应商将根据他们自己的时间表添加这些功能。

上次更新时间：2024年10月28日星期一 07:56:36 GMT+0000（协调世界时）

send​

通过 WebDriver Bidi 发送套接字命令

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.send(params)
参数​
名称类型详情
paramsCommandData套接字有效负载
返回值​
  • <Object> CommandResponse: WebDriver Bidi 响应

sendAsync​

通过 WebDriver Bidi 发送异步套接字命令

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.sendAsync(params)
参数​
名称类型详情
paramsCommandData套接字有效负载
返回值​
  • <Number> id: WebDriver Bidi 请求的 ID

sessionStatus​

WebDriver Bidi 命令，用于使用参数发送命令方法“session.status”。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.sessionStatus(params)
参数​
名称类型详情
paramsremote.EmptyParams
{}
返回值​
  • <Object> local.SessionStatusResult: 命令返回值，具有以下接口 
    {
      ready: boolean;
      message: string;
    }

sessionNew​

WebDriver Bidi 命令，用于使用参数发送命令方法“session.new”。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.sessionNew(params)
参数​
名称类型详情
paramsremote.SessionNewParameters
{
  capabilities: SessionCapabilitiesRequest;
}
返回值​
  • <Object> local.SessionNewResult: 命令返回值，具有以下接口 
    {
      sessionId: string;
      capabilities: {
        acceptInsecureCerts: boolean;
        browserName: string;
        browserVersion: string;
        platformName: string;
        setWindowRect: boolean;
        userAgent: string;
        proxy?: SessionProxyConfiguration;
        webSocketUrl?: string;
      };
    }

sessionEnd​

WebDriver Bidi 命令，用于使用参数发送命令方法“session.end”。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.sessionEnd(params)
参数​
名称类型详情
paramsremote.EmptyParams
{}

sessionSubscribe​

WebDriver Bidi 命令，用于使用参数发送命令方法“session.subscribe”。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.sessionSubscribe(params)
参数​
名称类型详情
paramsremote.SessionSubscriptionRequest
{
  events: string[];
  contexts?: BrowsingContextBrowsingContext[];
}

sessionUnsubscribe​

WebDriver Bidi 命令，用于使用参数发送命令方法“session.unsubscribe”。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.sessionUnsubscribe(params)
参数​
名称类型详情
paramsremote.SessionSubscriptionRequest
{
  events: string[];
  contexts?: BrowsingContextBrowsingContext[];
}

browserClose​

WebDriver Bidi 命令，用于使用参数发送命令方法“browser.close”。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.browserClose(params)
参数​
名称类型详情
paramsremote.EmptyParams
{}

browserCreateUserContext​

WebDriver Bidi 命令，用于使用参数发送命令方法“browser.createUserContext”。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.browserCreateUserContext(params)
参数​
名称类型详情
paramsremote.EmptyParams
{}
返回值​
  • <Object> local.BrowserCreateUserContextResult: 命令返回值，具有以下接口 
    ;

browserGetUserContexts​

WebDriver Bidi 命令，用于使用参数发送命令方法“browser.getUserContexts”。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.browserGetUserContexts(params)
参数​
名称类型详情
paramsremote.EmptyParams
{}
返回值​
  • <Object> local.BrowserGetUserContextsResult: 命令返回值，具有以下接口 
    {
      userContexts: BrowserUserContextInfo[];
    }

browserRemoveUserContext​

WebDriver Bidi 命令，用于使用参数发送命令方法“browser.removeUserContext”。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.browserRemoveUserContext(params)
参数​
名称类型详情
paramsremote.BrowserRemoveUserContextParameters
{
  userContext: BrowserUserContext;
}

browsingContextActivate​

WebDriver Bidi 命令，用于使用参数发送命令方法“browsingContext.activate”。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.browsingContextActivate(params)
参数​
名称类型详情
paramsremote.BrowsingContextActivateParameters
{
  context: BrowsingContextBrowsingContext;
}

browsingContextCaptureScreenshot​

WebDriver Bidi 命令，用于使用参数发送命令方法“browsingContext.captureScreenshot”。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.browsingContextCaptureScreenshot(params)
参数​
名称类型详情
paramsremote.BrowsingContextCaptureScreenshotParameters
{
  context: BrowsingContextBrowsingContext;
  /**
   * @default 'viewport'
   */
  origin?: "viewport" | "document";
  format?: BrowsingContextImageFormat;
  clip?: BrowsingContextClipRectangle;
}
返回值​
  • <对象> local.BrowsingContextCaptureScreenshotResult: 命令返回值，具有以下接口 
    {
      data: string;
    }

browsingContextClose​

WebDriver Bidi 命令，用于发送命令方法“browsingContext.close”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.browsingContextClose(params)
参数​
名称类型详情
paramsremote.BrowsingContextCloseParameters
{
  context: BrowsingContextBrowsingContext;
  promptUnload?: boolean;
}

browsingContextCreate​

WebDriver Bidi 命令，用于发送命令方法“browsingContext.create”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.browsingContextCreate(params)
参数​
名称类型详情
paramsremote.BrowsingContextCreateParameters
{
  type: BrowsingContextCreateType;
  referenceContext?: BrowsingContextBrowsingContext;
  background?: boolean;
  userContext?: BrowserUserContext;
}
返回值​
  • <对象> local.BrowsingContextCreateResult: 命令返回值，具有以下接口 
    {
      context: BrowsingContextBrowsingContext;
    }

browsingContextGetTree​

WebDriver Bidi 命令，用于发送命令方法“browsingContext.getTree”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.browsingContextGetTree(params)
参数​
名称类型详情
paramsremote.BrowsingContextGetTreeParameters
{
  maxDepth?: JsUint;
  root?: BrowsingContextBrowsingContext;
}
返回值​
  • <对象> local.BrowsingContextGetTreeResult: 命令返回值，具有以下接口 
    {
      contexts: BrowsingContextInfoList;
    }

browsingContextHandleUserPrompt​

WebDriver Bidi 命令，用于发送命令方法“browsingContext.handleUserPrompt”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.browsingContextHandleUserPrompt(params)
参数​
名称类型详情
paramsremote.BrowsingContextHandleUserPromptParameters
{
  context: BrowsingContextBrowsingContext;
  accept?: boolean;
  userText?: string;
}

browsingContextLocateNodes​

WebDriver Bidi 命令，用于发送命令方法“browsingContext.locateNodes”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.browsingContextLocateNodes(params)
参数​
名称类型详情
paramsremote.BrowsingContextLocateNodesParameters
{
  context: BrowsingContextBrowsingContext;
  locator: BrowsingContextLocator;
  maxNodeCount?: JsUint;
  serializationOptions?: ScriptSerializationOptions;
  startNodes?: ScriptSharedReference[];
}
返回值​
  • <对象> local.BrowsingContextLocateNodesResult: 命令返回值，具有以下接口 
    {
      nodes: ScriptNodeRemoteValue[];
    }

browsingContextNavigate​

WebDriver Bidi 命令，用于发送命令方法“browsingContext.navigate”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.browsingContextNavigate(params)
参数​
名称类型详情
paramsremote.BrowsingContextNavigateParameters
{
  context: BrowsingContextBrowsingContext;
  url: string;
  wait?: BrowsingContextReadinessState;
}
返回值​
  • <对象> local.BrowsingContextNavigateResult: 命令返回值，具有以下接口 
    {
      navigation: BrowsingContextNavigation | null;
      url: string;
    }

browsingContextPrint​

WebDriver Bidi 命令，用于发送命令方法“browsingContext.print”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.browsingContextPrint(params)
参数​
名称类型详情
paramsremote.BrowsingContextPrintParameters
{
  context: BrowsingContextBrowsingContext;
  background?: boolean;
  margin?: BrowsingContextPrintMarginParameters;
  /**
   * @default 'portrait'
   */
  orientation?: "portrait" | "landscape";
  page?: BrowsingContextPrintPageParameters;
  pageRanges?: (JsUint | string)[];
  /**
   * @default 1
   */
  scale?: number;
  /**
   * @default true
   */
  shrinkToFit?: boolean;
}
返回值​
  • <对象> local.BrowsingContextPrintResult: 命令返回值，具有以下接口 
    {
      data: string;
    }

browsingContextReload​

WebDriver Bidi 命令，用于发送命令方法“browsingContext.reload”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.browsingContextReload(params)
参数​
名称类型详情
paramsremote.BrowsingContextReloadParameters
{
  context: BrowsingContextBrowsingContext;
  ignoreCache?: boolean;
  wait?: BrowsingContextReadinessState;
}

browsingContextSetViewport​

WebDriver Bidi 命令，用于发送命令方法“browsingContext.setViewport”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.browsingContextSetViewport(params)
参数​
名称类型详情
paramsremote.BrowsingContextSetViewportParameters
{
  context: BrowsingContextBrowsingContext;
  viewport?: BrowsingContextViewport | null;
  devicePixelRatio?: number | null;
}

browsingContextTraverseHistory​

WebDriver Bidi 命令，用于发送命令方法“browsingContext.traverseHistory”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.browsingContextTraverseHistory(params)
参数​
名称类型详情
paramsremote.BrowsingContextTraverseHistoryParameters
{
  context: BrowsingContextBrowsingContext;
  delta: JsInt;
}

networkAddIntercept​

WebDriver Bidi 命令，用于发送命令方法“network.addIntercept”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.networkAddIntercept(params)
参数​
名称类型详情
paramsremote.NetworkAddInterceptParameters
{
  phases: NetworkInterceptPhase[];
  contexts?: BrowsingContextBrowsingContext[];
  urlPatterns?: NetworkUrlPattern[];
}
返回值​
  • <对象> local.NetworkAddInterceptResult: 命令返回值，具有以下接口 
    {
      intercept: NetworkIntercept;
    }

networkContinueRequest​

WebDriver Bidi 命令，用于发送命令方法“network.continueRequest”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.networkContinueRequest(params)
参数​
名称类型详情
paramsremote.NetworkContinueRequestParameters
{
  request: NetworkRequest;
  body?: NetworkBytesValue;
  cookies?: NetworkCookieHeader[];
  headers?: NetworkHeader[];
  method?: string;
  url?: string;
}

networkContinueResponse​

WebDriver Bidi 命令，用于发送命令方法“network.continueResponse”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.networkContinueResponse(params)
参数​
名称类型详情
paramsremote.NetworkContinueResponseParameters
{
  request: NetworkRequest;
  cookies?: NetworkSetCookieHeader[];
  credentials?: NetworkAuthCredentials;
  headers?: NetworkHeader[];
  reasonPhrase?: string;
  statusCode?: JsUint;
}

networkContinueWithAuth​

WebDriver Bidi 命令，用于发送命令方法“network.continueWithAuth”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.networkContinueWithAuth(params)
参数​
名称类型详情
paramsremote.NetworkContinueWithAuthParameters
{
  request: NetworkRequest;
}

networkFailRequest​

WebDriver Bidi 命令，用于发送命令方法“network.failRequest”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.networkFailRequest(params)
参数​
名称类型详情
paramsremote.NetworkFailRequestParameters
{
  request: NetworkRequest;
}

networkProvideResponse​

WebDriver Bidi 命令，用于发送命令方法“network.provideResponse”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

用法​
browser.networkProvideResponse(params)
参数​
名称类型详情
paramsremote.NetworkProvideResponseParameters
{
  request: NetworkRequest;
  body?: NetworkBytesValue;
  cookies?: NetworkSetCookieHeader[];
  headers?: NetworkHeader[];
  reasonPhrase?: string;
  statusCode?: JsUint;
}

networkRemoveIntercept​

WebDriver Bidi 命令，用于发送命令方法“network.removeIntercept”以及参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

使用​
browser.networkRemoveIntercept(params)
参数​
名称类型详情
paramsremote.NetworkRemoveInterceptParameters
{
  intercept: NetworkIntercept;
}

scriptAddPreloadScript​

WebDriver Bidi 命令，用于发送命令方法“script.addPreloadScript”及其参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

使用​
browser.scriptAddPreloadScript(params)
参数​
名称类型详情
paramsremote.ScriptAddPreloadScriptParameters
{
  functionDeclaration: string;
  arguments?: ScriptChannelValue[];
  contexts?: BrowsingContextBrowsingContext[];
  sandbox?: string;
}
返回值​
  • <对象> local.ScriptAddPreloadScriptResult: 命令返回值，具有以下接口 
    {
      script: ScriptPreloadScript;
    }

scriptDisown​

WebDriver Bidi 命令，用于发送命令方法“script.disown”及其参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

使用​
browser.scriptDisown(params)
参数​
名称类型详情
paramsremote.ScriptDisownParameters
{
  handles: ScriptHandle[];
  target: ScriptTarget;
}

scriptCallFunction​

WebDriver Bidi 命令，用于发送命令方法“script.callFunction”及其参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

使用​
browser.scriptCallFunction(params)
参数​
名称类型详情
paramsremote.ScriptCallFunctionParameters
{
  functionDeclaration: string;
  awaitPromise: boolean;
  target: ScriptTarget;
  arguments?: ScriptLocalValue[];
  resultOwnership?: ScriptResultOwnership;
  serializationOptions?: ScriptSerializationOptions;
  this?: ScriptLocalValue;
  userActivation?: boolean;
}

scriptEvaluate​

WebDriver Bidi 命令，用于发送命令方法“script.evaluate”及其参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

使用​
browser.scriptEvaluate(params)
参数​
名称类型详情
paramsremote.ScriptEvaluateParameters
{
  expression: string;
  target: ScriptTarget;
  awaitPromise: boolean;
  resultOwnership?: ScriptResultOwnership;
  serializationOptions?: ScriptSerializationOptions;
  userActivation?: boolean;
}
返回值​
  • <对象> local.ScriptEvaluateResult: 命令返回值，具有以下接口 
    ;

scriptGetRealms​

WebDriver Bidi 命令，用于发送命令方法“script.getRealms”及其参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

使用​
browser.scriptGetRealms(params)
参数​
名称类型详情
paramsremote.ScriptGetRealmsParameters
{
  context?: BrowsingContextBrowsingContext;
  type?: ScriptRealmType;
}
返回值​
  • <对象> local.ScriptGetRealmsResult: 命令返回值，具有以下接口 
    {
      realms: ScriptRealmInfo[];
    }

scriptRemovePreloadScript​

WebDriver Bidi 命令，用于发送命令方法“script.removePreloadScript”及其参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

使用​
browser.scriptRemovePreloadScript(params)
参数​
名称类型详情
paramsremote.ScriptRemovePreloadScriptParameters
{
  script: ScriptPreloadScript;
}

storageGetCookies​

WebDriver Bidi 命令，用于发送命令方法“storage.getCookies”及其参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

使用​
browser.storageGetCookies(params)
参数​
名称类型详情
paramsremote.StorageGetCookiesParameters
{
  filter?: StorageCookieFilter;
  partition?: StoragePartitionDescriptor;
}
返回值​
  • <对象> local.StorageGetCookiesResult: 命令返回值，具有以下接口 
    {
      cookies: NetworkCookie[];
      partitionKey: StoragePartitionKey;
    }

storageSetCookie​

WebDriver Bidi 命令，用于发送命令方法“storage.setCookie”及其参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

使用​
browser.storageSetCookie(params)
参数​
名称类型详情
paramsremote.StorageSetCookieParameters
{
  cookie: StoragePartialCookie;
  partition?: StoragePartitionDescriptor;
}
返回值​
  • <对象> local.StorageSetCookieResult: 命令返回值，具有以下接口 
    {
      partitionKey: StoragePartitionKey;
    }

storageDeleteCookies​

WebDriver Bidi 命令，用于发送命令方法“storage.deleteCookies”及其参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

使用​
browser.storageDeleteCookies(params)
参数​
名称类型详情
paramsremote.StorageDeleteCookiesParameters
{
  filter?: StorageCookieFilter;
  partition?: StoragePartitionDescriptor;
}
返回值​
  • <对象> local.StorageDeleteCookiesResult: 命令返回值，具有以下接口 
    {
      partitionKey: StoragePartitionKey;
    }

inputPerformActions​

WebDriver Bidi 命令，用于发送命令方法“input.performActions”及其参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

使用​
browser.inputPerformActions(params)
参数​
名称类型详情
paramsremote.InputPerformActionsParameters
{
  context: BrowsingContextBrowsingContext;
  actions: InputSourceActions[];
}

inputReleaseActions​

WebDriver Bidi 命令，用于发送命令方法“input.releaseActions”及其参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

使用​
browser.inputReleaseActions(params)
参数​
名称类型详情
paramsremote.InputReleaseActionsParameters
{
  context: BrowsingContextBrowsingContext;
}

inputSetFiles​

WebDriver Bidi 命令，用于发送命令方法“input.setFiles”及其参数。

WebDriver Bidi 协议命令。更多详细信息可以在官方协议文档中找到。

使用​
browser.inputSetFiles(params)
参数​
名称类型详情
paramsremote.InputSetFilesParameters
{
  context: BrowsingContextBrowsingContext;
  element: ScriptSharedReference;
  files: string[];
}

欢迎！我怎样才能帮助您？

WebdriverIO AI Copilot