On this page

CreateContextParameters

Represents a set of parameters for creating a context. Described in https://w3c.github.io/webdriver-bidi/#command-browsingContext-create.

Constructor

new CreateContextParameters()

Source: bidi/createContextParameters.js, line 22

Methods

background(background) → {CreateContextParameters}

Sets the background parameter.

Parameters:

Name	Type	Description
`background`	boolean	The background value to set.

Source: bidi/createContextParameters.js, line 46

Throws:

If the background parameter is not a boolean.
Type Error

Returns:

The updated instance of CreateContextParameters for chaining.

Type:: CreateContextParameters

referenceContext(id) → {CreateContextParameters}

Sets the reference context.

Parameters:

Name	Type	Description
`id`	string	The ID of the reference context.

Source: bidi/createContextParameters.js, line 31

Throws:

If the provided ID is not a string.
Type Error

Returns:

The updated instance of CreateContextParameters for chaining.

Type:: CreateContextParameters

userContext(userContext) → {CreateContextParameters}

Sets the user context.

Parameters:

Name	Type	Description
`userContext`	string	The user context to set.

Source: bidi/createContextParameters.js, line 60

Throws:

If the userContext parameter is not a string.
Type Error

Returns:

The updated instance of CreateContextParameters for chaining.

Type:: CreateContextParameters