The browser.removeUserContext command of the browser module removes the specified user context and all its tabs across all windows. Tabs are closed without running the beforeunload event handler functions.
[!WARNING] This command is irreversible, and all storage associated with the user context is permanently deleted.
Syntax
{
"method": "browser.removeUserContext",
"params": {
"userContext": "4e4b1f6d-3f1a-4b2e-9f8c-1a2b3c4d5e6f"
}
}
Parameters
The params field contains:
userContext- : A string that contains the ID of the user context to remove.
User context IDs are returned by commands such as
browser.createUserContextorbrowser.getUserContexts. The default user context ("default") cannot be removed.
- : A string that contains the ID of the user context to remove.
User context IDs are returned by commands such as
Return value
The result field in the response is an empty object ({}).
Errors
invalid argument- : The
userContextfield is"default". The default user context cannot be removed.
- : The
no such user context- : No user context with the given user context ID is found.
Examples
Removing a user context
Consider a scenario where you have a WebDriver BiDi connection and an active session. After creating a user context with browser.createUserContext, send the following message if you want to remove it:
{
"id": 1,
"method": "browser.removeUserContext",
"params": {
"userContext": "4e4b1f6d-3f1a-4b2e-9f8c-1a2b3c4d5e6f"
}
}
The browser responds with a successful removal as follows:
{
"id": 1,
"type": "success",
"result": {}
}
Specifications
Browser compatibility
See also
session.newcommandbrowser.createUserContextcommandbrowser.getUserContextscommandbrowser.closecommandsession.endcommand
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
