Update Virtual Pressure Source
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
The Update Virtual Pressure Source command of the WebDriver API sets a new sample for a virtual pressure source previously created with the Create Virtual Pressure Source command. The new sample is delivered to the page through the Compute Pressure API, letting tests drive pressure-dependent behavior with predetermined data.
Syntax
| Method | URI template |
|---|---|
POST |
/session/{session id}/pressuresource/{type} |
URL parameters
session id-
Identifier of the session.
type-
The pressure source type to update, for example
"cpu".
Payload
The input is an object:
sample-
A string giving the pressure state to report. One of
"nominal","fair","serious", or"critical". ownContributionEstimateOptional-
A number between
0and1estimating the fraction of the reported pressure that is caused by the page itself.
Return value
null if successful.
Errors
invalid session id-
Session does not exist.
invalid argument-
The
sampleis not a valid pressure state, orownContributionEstimateis not a valid number. unsupported operation-
No virtual pressure source of the given
typehas been created.
Examples
Updating a virtual pressure source
With a WebDriver server running on localhost:4444, assume a virtual "cpu" pressure source has been created for the active session. To report a new pressure state, send the sample value as the request payload, replacing ID with the sessionId from the New Session response:
curl -i -H "Content-Type: application/json" \
-d '{"sample": "critical"}' \
http://localhost:4444/session/ID/pressuresource/cpu
The server responds with a null value to indicate success:
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
{"value":null}
Specifications
| Specification |
|---|
| Compute Pressure Level 1 # update-virtual-pressure-source |