Network

Represents all commands and events of Network module. Described in https://w3c.github.io/webdriver-bidi/#module-network.

Constructor

new Network(driver, browsingContextIds)

Represents a Network object.

Parameters:

Name	Type	Description
`driver`	Driver	The driver to fetch the BiDi connection.
`browsingContextIds`	Array	An array of browsing context IDs that the network events will be subscribed to.

Source: bidi/network.js,line 41

Methods

(async)addIntercept(params) → {Promise.<string>}

Adds a network intercept.

Parameters:

Name	Type	Description
`params`	AddInterceptParameters	The parameters for the network intercept.

Source: bidi/network.js,line 201

Throws:

If params is not an instance of AddInterceptParameters.
Type Error

Returns:

A promise that resolves to the added intercept's id.

Type:: Promise.<string>

(async)authRequired(callback) → {Promise.<number>}

Subscribes to the 'network.authRequired' event and handles it with the provided callback.

Parameters:

Name	Type	Description
`callback`	function	The callback function to handle the event.

Source: bidi/network.js,line 133

Returns:

A promise that resolves when the subscription is successful.

Type:: Promise.<number>

(async)beforeRequestSent(callback) → {Promise.<void>}

Subscribes to the 'network.beforeRequestSent' event and handles it with the provided callback.

Parameters:

Name	Type	Description
`callback`	function	The callback function to handle the event.

Source: bidi/network.js,line 103

Returns:

A promise that resolves when the subscription is successful.

Type:: Promise.<void>

(async)cancelAuth(requestId) → {Promise.<void>}

Cancels the authentication for a specific request.

Parameters:

Name	Type	Description
`requestId`	string	The ID of the request to cancel authentication for.

Source: bidi/network.js,line 292

Returns:

A promise that resolves when the command is sent.

Type:: Promise.<void>

(async)close() → {Promise.<void>}

Unsubscribes from network events for all browsing contexts.

Source: bidi/network.js,line 401

Returns:

A promise that resolves when the network connection is closed.

Type:: Promise.<void>

(async)continueRequest(params) → {Promise.<void>}

Continues the network request with the provided parameters.

Parameters:

Name	Type	Description
`params`	ContinueRequestParameters	The parameters for continuing the request.

Source: bidi/network.js,line 310

Throws:

If params is not an instance of ContinueRequestParameters.
Type Error

Returns:

A promise that resolves when the command is sent.

Type:: Promise.<void>

(async)continueResponse(params) → {Promise.<void>}

Continues the network response with the given parameters.

Parameters:

Name	Type	Description
`params`	ContinueResponseParameters	The parameters for continuing the response.

Source: bidi/network.js,line 330

Throws:

If params is not an instance of ContinueResponseParameters.
Type Error

Returns:

A promise that resolves when the command is sent.

Type:: Promise.<void>

(async)continueWithAuth(requestId, username, password) → {Promise.<void>}

Continues the network request with authentication credentials.

Parameters:

Name	Type	Description
`requestId`	string	The ID of the request to continue.
`username`	string	The username for authentication.
`password`	string	The password for authentication.

Source: bidi/network.js,line 238

Returns:

A promise that resolves when the command is sent.

Type:: Promise.<void>

(async)continueWithAuthNoCredentials(requestId) → {Promise.<void>}

Continues the network request with authentication but without providing credentials.

Parameters:

Name	Type	Description
`requestId`	string	The ID of the request to continue with authentication.

Source: bidi/network.js,line 275

Returns:

A promise that resolves when the command is sent.

Type:: Promise.<void>

(async)failRequest(requestId) → {Promise.<void>}

Fails a network request.

Parameters:

Name	Type	Description
`requestId`	number	The ID of the request to fail.

Source: bidi/network.js,line 260

Returns:

A promise that resolves when the command is sent.

Type:: Promise.<void>

(async)fetchError(callback) → {Promise.<void>}

Subscribes to the 'network.fetchError' event and handles it with the provided callback.

Parameters:

Name	Type	Description
`callback`	function	The callback function to handle the event.

Source: bidi/network.js,line 143

Returns:

A promise that resolves when the subscription is successful.

Type:: Promise.<void>

(async)provideResponse(params) → {Promise.<void>}

Provides a response for the network.

Parameters:

Name	Type	Description
`params`	ProvideResponseParameters	The parameters for providing the response.

Source: bidi/network.js,line 350

Throws:

If params is not an instance of ProvideResponseParameters.
Type Error

Returns:

A promise that resolves when the command is sent.

Type:: Promise.<void>

(async)removeIntercept(interceptId) → {Promise.<void>}

Removes an intercept.

Parameters:

Name	Type	Description
`interceptId`	string	The ID of the intercept to be removed.

Source: bidi/network.js,line 222

Returns:

A promise that resolves when the intercept is successfully removed.

Type:: Promise.<void>

(async)responseCompleted(callback) → {Promise.<void>}

Subscribes to the 'network.responseCompleted' event and handles it with the provided callback.

Parameters:

Name	Type	Description
`callback`	function	The callback function to handle the event.

Source: bidi/network.js,line 123

Returns:

A promise that resolves when the subscription is successful.

Type:: Promise.<void>

(async)responseStarted(callback) → {Promise.<void>}

Subscribes to the 'network.responseStarted' event and handles it with the provided callback.

Parameters:

Name	Type	Description
`callback`	function	The callback function to handle the event.

Source: bidi/network.js,line 113

Returns:

A promise that resolves when the subscription is successful.

Type:: Promise.<void>

(async)setCacheBehavior(behavior, contextsopt) → {Promise.<void>}

Sets the cache behavior for network requests.

Parameters:

Name	Type	Attributes	Default	Description
`behavior`	string			The cache behavior ("default" or "bypass")
`contexts`	Array.<string>	<optional>	null	Optional array of browsing context IDs

Source: bidi/network.js,line 371

Throws:

If behavior is invalid or context IDs are invalid
Type Error

Returns:

A promise that resolves when the cache behavior is set

Type:: Promise.<void>

Movatterモバイル変換

Constructor

new Network(driver, browsingContextIds)

Methods

(async)addIntercept(params) → {Promise.<string>}

(async)authRequired(callback) → {Promise.<number>}

(async)beforeRequestSent(callback) → {Promise.<void>}

(async)cancelAuth(requestId) → {Promise.<void>}

(async)close() → {Promise.<void>}

(async)continueRequest(params) → {Promise.<void>}

(async)continueResponse(params) → {Promise.<void>}

(async)continueWithAuth(requestId, username, password) → {Promise.<void>}

(async)continueWithAuthNoCredentials(requestId) → {Promise.<void>}

(async)failRequest(requestId) → {Promise.<void>}

(async)fetchError(callback) → {Promise.<void>}

(async)provideResponse(params) → {Promise.<void>}

(async)removeIntercept(interceptId) → {Promise.<void>}

(async)responseCompleted(callback) → {Promise.<void>}

(async)responseStarted(callback) → {Promise.<void>}

(async)setCacheBehavior(behavior, contextsopt) → {Promise.<void>}