Aller au contenu principal

Protocole WebDriver Bidi

Ces commandes de protocole sont générées sur la base de la spécification actuelle WebDriver Bidi. Pour activer le protocole pour votre test, assurez-vous d'avoir défini webSocketUrl: true dans vos capacités.

Utilisez avec précaution !

La prise en charge par les navigateurs n'est pas garantie et les interfaces peuvent changer à l'avenir. La norme est actuellement en cours de développement et les fournisseurs de navigateurs ajouteront ces fonctionnalités selon leurs propres calendriers.

Dernière mise à jour : Sat Apr 26 2025 17:10:07 GMT-0700 (Pacific Daylight Time)


send​

Envoyer des commandes socket via WebDriver Bidi

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.send(params)
Paramètres​
NomTypeDétails
paramsCommandDatacharge utile du socket
Retourne​
  • <Object> CommandResponse: Réponse WebDriver Bidi

sendAsync​

Envoyer des commandes socket asynchrones via WebDriver Bidi

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.sendAsync(params)
Paramètres​
NomTypeDétails
paramsCommandDatacharge utile du socket
Retourne​
  • <Number> id: id de la requête WebDriver Bidi

sessionStatus​

Commande WebDriver Bidi pour envoyer la méthode de commande "session.status" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.sessionStatus(params)
Paramètres​
NomTypeDétails
paramsremote.EmptyParams
{}
Retourne​
  • <Object> local.SessionStatusResult: Valeur de retour de la commande avec l'interface suivante:
    {
    ready: boolean;
    message: string;
    }

sessionNew​

Commande WebDriver Bidi pour envoyer la méthode de commande "session.new" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.sessionNew(params)
Paramètres​
NomTypeDétails
paramsremote.SessionNewParameters
{
capabilities: SessionCapabilitiesRequest;
}
Retourne​
  • <Object> local.SessionNewResult: Valeur de retour de la commande avec l'interface suivante:
    {
    sessionId: string;
    capabilities: {
    acceptInsecureCerts: boolean;
    browserName: string;
    browserVersion: string;
    platformName: string;
    setWindowRect: boolean;
    userAgent: string;
    proxy?: SessionProxyConfiguration;
    webSocketUrl?: string;
    };
    }

sessionEnd​

Commande WebDriver Bidi pour envoyer la méthode de commande "session.end" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.sessionEnd(params)
Paramètres​
NomTypeDétails
paramsremote.EmptyParams
{}

sessionSubscribe​

Commande WebDriver Bidi pour envoyer la méthode de commande "session.subscribe" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.sessionSubscribe(params)
Paramètres​
NomTypeDétails
paramsremote.SessionSubscriptionRequest
{
events: string[];
contexts?: BrowsingContextBrowsingContext[];
}

sessionUnsubscribe​

Commande WebDriver Bidi pour envoyer la méthode de commande "session.unsubscribe" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.sessionUnsubscribe(params)
Paramètres​
NomTypeDétails
paramsremote.SessionSubscriptionRequest
{
events: string[];
contexts?: BrowsingContextBrowsingContext[];
}

browserClose​

Commande WebDriver Bidi pour envoyer la méthode de commande "browser.close" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.browserClose(params)
Paramètres​
NomTypeDétails
paramsremote.EmptyParams
{}

browserCreateUserContext​

Commande WebDriver Bidi pour envoyer la méthode de commande "browser.createUserContext" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.browserCreateUserContext(params)
Paramètres​
NomTypeDétails
paramsremote.EmptyParams
{}
Retourne​
  • <Object> local.BrowserCreateUserContextResult: Valeur de retour de la commande avec l'interface suivante:
    ;

browserGetUserContexts​

Commande WebDriver Bidi pour envoyer la méthode de commande "browser.getUserContexts" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.browserGetUserContexts(params)
Paramètres​
NomTypeDétails
paramsremote.EmptyParams
{}
Retourne​
  • <Object> local.BrowserGetUserContextsResult: Valeur de retour de la commande avec l'interface suivante:
    {
    userContexts: BrowserUserContextInfo[];
    }

browserRemoveUserContext​

Commande WebDriver Bidi pour envoyer la méthode de commande "browser.removeUserContext" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.browserRemoveUserContext(params)
Paramètres​
NomTypeDétails
paramsremote.BrowserRemoveUserContextParameters
{
userContext: BrowserUserContext;
}

browsingContextActivate​

Commande WebDriver Bidi pour envoyer la méthode de commande "browsingContext.activate" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.browsingContextActivate(params)
Paramètres​
NomTypeDétails
paramsremote.BrowsingContextActivateParameters
{
context: BrowsingContextBrowsingContext;
}

browsingContextCaptureScreenshot​

Commande WebDriver Bidi pour envoyer la méthode de commande "browsingContext.captureScreenshot" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.browsingContextCaptureScreenshot(params)
Paramètres​
NomTypeDétails
paramsremote.BrowsingContextCaptureScreenshotParameters
{
context: BrowsingContextBrowsingContext;
/**
* @default 'viewport'
*/
origin?: "viewport" | "document";
format?: BrowsingContextImageFormat;
clip?: BrowsingContextClipRectangle;
}
Retourne​
  • <Object> local.BrowsingContextCaptureScreenshotResult: Valeur de retour de la commande avec l'interface suivante:
    {
    data: string;
    }

browsingContextClose​

Commande WebDriver Bidi pour envoyer la méthode de commande "browsingContext.close" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.browsingContextClose(params)
Paramètres​
NomTypeDétails
paramsremote.BrowsingContextCloseParameters
{
context: BrowsingContextBrowsingContext;
promptUnload?: boolean;
}

browsingContextCreate​

Commande WebDriver Bidi pour envoyer la méthode de commande "browsingContext.create" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.browsingContextCreate(params)
Paramètres​
NomTypeDétails
paramsremote.BrowsingContextCreateParameters
{
type: BrowsingContextCreateType;
referenceContext?: BrowsingContextBrowsingContext;
background?: boolean;
userContext?: BrowserUserContext;
}
Retourne​
  • <Object> local.BrowsingContextCreateResult: Valeur de retour de la commande avec l'interface suivante:
    {
    context: BrowsingContextBrowsingContext;
    }

browsingContextGetTree​

Commande WebDriver Bidi pour envoyer la méthode de commande "browsingContext.getTree" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.browsingContextGetTree(params)
Paramètres​
NomTypeDétails
paramsremote.BrowsingContextGetTreeParameters
{
maxDepth?: JsUint;
root?: BrowsingContextBrowsingContext;
}
Retourne​
  • <Object> local.BrowsingContextGetTreeResult: Valeur de retour de la commande avec l'interface suivante:
    {
    contexts: BrowsingContextInfoList;
    }

browsingContextHandleUserPrompt​

Commande WebDriver Bidi pour envoyer la méthode de commande "browsingContext.handleUserPrompt" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.browsingContextHandleUserPrompt(params)
Paramètres​
NomTypeDétails
paramsremote.BrowsingContextHandleUserPromptParameters
{
context: BrowsingContextBrowsingContext;
accept?: boolean;
userText?: string;
}

browsingContextLocateNodes​

Commande WebDriver Bidi pour envoyer la méthode de commande "browsingContext.locateNodes" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.browsingContextLocateNodes(params)
Paramètres​
NomTypeDétails
paramsremote.BrowsingContextLocateNodesParameters
{
context: BrowsingContextBrowsingContext;
locator: BrowsingContextLocator;
maxNodeCount?: JsUint;
serializationOptions?: ScriptSerializationOptions;
startNodes?: ScriptSharedReference[];
}
Retourne​
  • <Object> local.BrowsingContextLocateNodesResult: Valeur de retour de la commande avec l'interface suivante:
    {
    nodes: ScriptNodeRemoteValue[];
    }

browsingContextNavigate​

Commande WebDriver Bidi pour envoyer la méthode de commande "browsingContext.navigate" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.browsingContextNavigate(params)
Paramètres​
NomTypeDétails
paramsremote.BrowsingContextNavigateParameters
{
context: BrowsingContextBrowsingContext;
url: string;
wait?: BrowsingContextReadinessState;
}
Retourne​
  • <Object> local.BrowsingContextNavigateResult: Valeur de retour de la commande avec l'interface suivante:
    {
    navigation: BrowsingContextNavigation | null;
    url: string;
    }

browsingContextPrint​

Commande WebDriver Bidi pour envoyer la méthode de commande "browsingContext.print" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.browsingContextPrint(params)
Paramètres​
NomTypeDétails
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;
}
Retourne​
  • <Object> local.BrowsingContextPrintResult: Valeur de retour de la commande avec l'interface suivante:
    {
    data: string;
    }

browsingContextReload​

Commande WebDriver Bidi pour envoyer la méthode de commande "browsingContext.reload" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.browsingContextReload(params)
Paramètres​
NomTypeDétails
paramsremote.BrowsingContextReloadParameters
{
context: BrowsingContextBrowsingContext;
ignoreCache?: boolean;
wait?: BrowsingContextReadinessState;
}

browsingContextSetViewport​

Commande WebDriver Bidi pour envoyer la méthode de commande "browsingContext.setViewport" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.browsingContextSetViewport(params)
Paramètres​
NomTypeDétails
paramsremote.BrowsingContextSetViewportParameters
{
context: BrowsingContextBrowsingContext;
viewport?: BrowsingContextViewport | null;
devicePixelRatio?: number | null;
}

browsingContextTraverseHistory​

Commande WebDriver Bidi pour envoyer la méthode de commande "browsingContext.traverseHistory" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.browsingContextTraverseHistory(params)
Paramètres​
NomTypeDétails
paramsremote.BrowsingContextTraverseHistoryParameters
{
context: BrowsingContextBrowsingContext;
delta: JsInt;
}

networkAddIntercept​

Commande WebDriver Bidi pour envoyer la méthode de commande "network.addIntercept" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.networkAddIntercept(params)
Paramètres​
NomTypeDétails
paramsremote.NetworkAddInterceptParameters
{
phases: NetworkInterceptPhase[];
contexts?: BrowsingContextBrowsingContext[];
urlPatterns?: NetworkUrlPattern[];
}
Retourne​
  • <Object> local.NetworkAddInterceptResult: Valeur de retour de la commande avec l'interface suivante:
    {
    intercept: NetworkIntercept;
    }

networkContinueRequest​

Commande WebDriver Bidi pour envoyer la méthode de commande "network.continueRequest" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.networkContinueRequest(params)
Paramètres​
NomTypeDétails
paramsremote.NetworkContinueRequestParameters
{
request: NetworkRequest;
body?: NetworkBytesValue;
cookies?: NetworkCookieHeader[];
headers?: NetworkHeader[];
method?: string;
url?: string;
}

networkContinueResponse​

Commande WebDriver Bidi pour envoyer la méthode de commande "network.continueResponse" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.networkContinueResponse(params)
Paramètres​
NomTypeDétails
paramsremote.NetworkContinueResponseParameters
{
request: NetworkRequest;
cookies?: NetworkSetCookieHeader[];
credentials?: NetworkAuthCredentials;
headers?: NetworkHeader[];
reasonPhrase?: string;
statusCode?: JsUint;
}

networkContinueWithAuth​

Commande WebDriver Bidi pour envoyer la méthode de commande "network.continueWithAuth" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.networkContinueWithAuth(params)
Paramètres​
NomTypeDétails
paramsremote.NetworkContinueWithAuthParameters
{
request: NetworkRequest;
}

networkFailRequest​

Commande WebDriver Bidi pour envoyer la méthode de commande "network.failRequest" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.networkFailRequest(params)
Paramètres​
NomTypeDétails
paramsremote.NetworkFailRequestParameters
{
request: NetworkRequest;
}

networkProvideResponse​

Commande WebDriver Bidi pour envoyer la méthode de commande "network.provideResponse" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.networkProvideResponse(params)
Paramètres​
NomTypeDétails
paramsremote.NetworkProvideResponseParameters
{
request: NetworkRequest;
body?: NetworkBytesValue;
cookies?: NetworkSetCookieHeader[];
headers?: NetworkHeader[];
reasonPhrase?: string;
statusCode?: JsUint;
}

networkRemoveIntercept​

Commande WebDriver Bidi pour envoyer la méthode de commande "network.removeIntercept" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.networkRemoveIntercept(params)
Paramètres​
NomTypeDétails
paramsremote.NetworkRemoveInterceptParameters
{
intercept: NetworkIntercept;
}

scriptAddPreloadScript​

Commande WebDriver Bidi pour envoyer la méthode de commande "script.addPreloadScript" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.scriptAddPreloadScript(params)
Paramètres​
NomTypeDétails
paramsremote.ScriptAddPreloadScriptParameters
{
functionDeclaration: string;
arguments?: ScriptChannelValue[];
contexts?: BrowsingContextBrowsingContext[];
sandbox?: string;
}
Retourne​
  • <Object> local.ScriptAddPreloadScriptResult: Valeur de retour de la commande avec l'interface suivante:
    {
    script: ScriptPreloadScript;
    }

scriptDisown​

Commande WebDriver Bidi pour envoyer la méthode de commande "script.disown" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.scriptDisown(params)
Paramètres​
NomTypeDétails
paramsremote.ScriptDisownParameters
{
handles: ScriptHandle[];
target: ScriptTarget;
}

scriptCallFunction​

Commande WebDriver Bidi pour envoyer la méthode de commande "script.callFunction" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.scriptCallFunction(params)
Paramètres​
NomTypeDétails
paramsremote.ScriptCallFunctionParameters
{
functionDeclaration: string;
awaitPromise: boolean;
target: ScriptTarget;
arguments?: ScriptLocalValue[];
resultOwnership?: ScriptResultOwnership;
serializationOptions?: ScriptSerializationOptions;
this?: ScriptLocalValue;
userActivation?: boolean;
}

scriptEvaluate​

Commande WebDriver Bidi pour envoyer la méthode de commande "script.evaluate" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.scriptEvaluate(params)
Paramètres​
NomTypeDétails
paramsremote.ScriptEvaluateParameters
{
expression: string;
target: ScriptTarget;
awaitPromise: boolean;
resultOwnership?: ScriptResultOwnership;
serializationOptions?: ScriptSerializationOptions;
userActivation?: boolean;
}
Retourne​
  • <Object> local.ScriptEvaluateResult: Valeur de retour de la commande avec l'interface suivante:
    ;

scriptGetRealms​

Commande WebDriver Bidi pour envoyer la méthode de commande "script.getRealms" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.scriptGetRealms(params)
Paramètres​
NomTypeDétails
paramsremote.ScriptGetRealmsParameters
{
context?: BrowsingContextBrowsingContext;
type?: ScriptRealmType;
}
Retourne​
  • <Object> local.ScriptGetRealmsResult: Valeur de retour de la commande avec l'interface suivante:
    {
    realms: ScriptRealmInfo[];
    }

scriptRemovePreloadScript​

Commande WebDriver Bidi pour envoyer la méthode de commande "script.removePreloadScript" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.scriptRemovePreloadScript(params)
Paramètres​
NomTypeDétails
paramsremote.ScriptRemovePreloadScriptParameters
{
script: ScriptPreloadScript;
}

storageGetCookies​

Commande WebDriver Bidi pour envoyer la méthode de commande "storage.getCookies" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.storageGetCookies(params)
Paramètres​
NomTypeDétails
paramsremote.StorageGetCookiesParameters
{
filter?: StorageCookieFilter;
partition?: StoragePartitionDescriptor;
}
Retourne​
  • <Object> local.StorageGetCookiesResult: Valeur de retour de la commande avec l'interface suivante:
    {
    cookies: NetworkCookie[];
    partitionKey: StoragePartitionKey;
    }

storageSetCookie​

Commande WebDriver Bidi pour envoyer la méthode de commande "storage.setCookie" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.storageSetCookie(params)
Paramètres​
NomTypeDétails
paramsremote.StorageSetCookieParameters
{
cookie: StoragePartialCookie;
partition?: StoragePartitionDescriptor;
}
Retourne​
  • <Object> local.StorageSetCookieResult: Valeur de retour de la commande avec l'interface suivante:
    {
    partitionKey: StoragePartitionKey;
    }

storageDeleteCookies​

Commande WebDriver Bidi pour envoyer la méthode de commande "storage.deleteCookies" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.storageDeleteCookies(params)
Paramètres​
NomTypeDétails
paramsremote.StorageDeleteCookiesParameters
{
filter?: StorageCookieFilter;
partition?: StoragePartitionDescriptor;
}
Retourne​
  • <Object> local.StorageDeleteCookiesResult: Valeur de retour de la commande avec l'interface suivante:
    {
    partitionKey: StoragePartitionKey;
    }

inputPerformActions​

Commande WebDriver Bidi pour envoyer la méthode de commande "input.performActions" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.inputPerformActions(params)
Paramètres​
NomTypeDétails
paramsremote.InputPerformActionsParameters
{
context: BrowsingContextBrowsingContext;
actions: InputSourceActions[];
}

inputReleaseActions​

Commande WebDriver Bidi pour envoyer la méthode de commande "input.releaseActions" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.inputReleaseActions(params)
Paramètres​
NomTypeDétails
paramsremote.InputReleaseActionsParameters
{
context: BrowsingContextBrowsingContext;
}

inputSetFiles​

Commande WebDriver Bidi pour envoyer la méthode de commande "input.setFiles" avec des paramètres.

Commande de protocole WebDriver Bidi. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation​
browser.inputSetFiles(params)
Paramètres​
NomTypeDétails
paramsremote.InputSetFilesParameters
{
context: BrowsingContextBrowsingContext;
element: ScriptSharedReference;
files: string[];
}

Welcome! How can I help?

WebdriverIO AI Copilot