Delete Virtual Sensor
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
The Delete Virtual Sensor command of the WebDriver API removes a virtual sensor previously created with the Create Virtual Sensor command. After the virtual sensor is deleted, the Sensor APIs once again use the real platform sensor of that type, if one is available.
Syntax
| Method | URI template |
|---|---|
DELETE |
/session/{session id}/sensor/{type} |
URL parameters
session id-
Identifier of the session.
type-
The virtual sensor type to delete, for example
"ambient-light".
Return value
null if successful.
Errors
invalid session id-
Session does not exist.
invalid argument-
No virtual sensor of the given
typeexists.
Examples
Deleting a virtual sensor
With a WebDriver server running on localhost:4444, assume a virtual "ambient-light" sensor has been created for the active session. To remove it, send a DELETE request with the sensor type appended to the endpoint, replacing ID with the sessionId from the New Session response:
curl -i -X DELETE http://localhost:4444/session/ID/sensor/ambient-light
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 |
|---|
| Generic Sensor API # delete-virtual-sensor-command |
Browser compatibility
See also
- Create Virtual Sensor command
- Update Virtual Sensor Reading command
- Get Virtual Sensor Information command
- Sensor APIs