abortGetUserSelection

The abortGetUserSelection method is used to cancel an active user selection prompt that was initiated using the getUserSelection method.

Request

📘

JSON-RPC 2.0

All methods in TweezerComm follow a JSON-RPC 2.0 structure. See Get Startedfor more details on how the requests are structured and sent.

To invoke this method, set the method field to abortGetUserSelection, and include the service name in the params array.

{
    "jsonrpc": "2.0",
    "method": "abortGetUserSelection",
    "id": "123",
    "params": [
        "device",
        {}
    ]
}

Request Parameters

The table below describes the parameters of the request:

NameTypeDescription
devicestringThe service name (fixed value)

Response

A successful request will return the following response:

{
    "jsonrpc": "2.0",
    "id": "123",
    "result": {
        "statusCode": 0,
        "statusMessage": "canceled"
    }
}

Response Parameters

The table below describes the response parameters for this method:

NameTypeDescription
statusCodeintegerOperation status (0 = success)
statusMessagestringMessage indicating operation result