メインコンテンツにスキップ

WebDriver Bidi プロトコル

これらのプロトコルコマンドは、現在のリビングWebDriver Bidi仕様に基づいて生成されます。テストでプロトコルを有効にするには、機能にwebSocketUrl: trueが設定されていることを確認してください。

注意して使用してください！

ブラウザのサポートは保証されておらず、インターフェースは将来変更される可能性があります。現在、標準は開発中であり、ブラウザベンダーは独自のタイムラインに基づいてこれらの機能を追加します。

最終更新日: 2024年10月28日（月）07:56:36 GMT+0000（協定世界時）

送信​

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;
}
戻り値​
  • <Object> 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;
}
戻り値​
  • <Object> local.BrowsingContextCreateResult: 次のインターフェースを持つコマンドの戻り値 
    {
      context: BrowsingContextBrowsingContext;
    }

browsingContextGetTree​

WebDriver Bidiコマンドで、パラメータ付きのコマンドメソッド "browsingContext.getTree" を送信します。

WebDriver Bidiプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。

使用法​
browser.browsingContextGetTree(params)
パラメータ​
名前型詳細
paramsremote.BrowsingContextGetTreeParameters
{
  maxDepth?: JsUint;
  root?: BrowsingContextBrowsingContext;
}
戻り値​
  • <Object> 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[];
}
戻り値​
  • <Object> local.BrowsingContextLocateNodesResult: 次のインターフェースを持つコマンドの戻り値 
    {
      nodes: ScriptNodeRemoteValue[];
    }

browsingContextNavigate​

WebDriver Bidiコマンドで、パラメータ付きのコマンドメソッド "browsingContext.navigate" を送信します。

WebDriver Bidiプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。

使用法​
browser.browsingContextNavigate(params)
パラメータ​
名前型詳細
paramsremote.BrowsingContextNavigateParameters
{
  context: BrowsingContextBrowsingContext;
  url: string;
  wait?: BrowsingContextReadinessState;
}
戻り値​
  • <Object> 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;
}
戻り値​
  • <Object> 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[];
}
戻り値​
  • <Object> 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;
}
戻り値​
  • <Object> 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;
}
戻り値​
  • <Object> local.ScriptEvaluateResult: 次のインターフェースを持つコマンドの戻り値 
    ;

scriptGetRealms​

WebDriver Bidi コマンドで、パラメータ付きのコマンドメソッド "script.getRealms" を送信します。

WebDriver Bidi プロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。

使用法​
browser.scriptGetRealms(params)
パラメータ​
名前型詳細
paramsremote.ScriptGetRealmsParameters
{
  context?: BrowsingContextBrowsingContext;
  type?: ScriptRealmType;
}
戻り値​
  • <Object> 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;
}
戻り値​
  • <Object> local.StorageGetCookiesResult: 次のインターフェースを持つコマンドの戻り値 
    {
      cookies: NetworkCookie[];
      partitionKey: StoragePartitionKey;
    }

storageSetCookie​

WebDriver Bidi コマンドで、パラメータ付きのコマンドメソッド "storage.setCookie" を送信します。

WebDriver Bidi プロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。

使用法​
browser.storageSetCookie(params)
パラメータ​
名前型詳細
paramsremote.StorageSetCookieParameters
{
  cookie: StoragePartialCookie;
  partition?: StoragePartitionDescriptor;
}
戻り値​
  • <Object> local.StorageSetCookieResult: 次のインターフェースを持つコマンドの戻り値 
    {
      partitionKey: StoragePartitionKey;
    }

storageDeleteCookies​

WebDriver Bidi コマンドで、パラメータ付きのコマンドメソッド "storage.deleteCookies" を送信します。

WebDriver Bidi プロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。

使用法​
browser.storageDeleteCookies(params)
パラメータ​
名前型詳細
paramsremote.StorageDeleteCookiesParameters
{
  filter?: StorageCookieFilter;
  partition?: StoragePartitionDescriptor;
}
戻り値​
  • <Object> 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