[Filter] klay_uninstallFilter

Uninstalls a filter with given id. Should always be called when watch is no longer needed. Additionally, filters timeout when they are not requested with klay_getFilterChanges for a period of time.

JSONRPC: klay_uninstallFilter

Request

application/json

Body

params Filter (string)[]

The filter id

Responses

200

Return true if the filter was successfully uninstalled, otherwise false.

application/json

Schema

Schema

error

object

code int64required

A Number that indicates the error type that occurred. This MUST be an integer.

code	message	description
-32700	Parse error	invalid JSON was received by the server. An error occurred on the server while parsing the JSON text.
-32602	Invalid params	Invalid method parameter(s).

message string

A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.

data string

A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).

result boolean

true if the filter was successfully uninstalled, otherwise false.

Example (from schema)

{
  "jsonrpc": "2.0",
  "id": 0,
  "error": {
    "code": -32700,
    "message": "Parse error",
    "data": "string"
  },
  "result": true
}

Loading...