This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
To Top
To Bottom
UnsubscribeButton
- Type
- Function
- Sender
- SDL
- Purpose
- Unsubscribe application from a button
Request
Must
- Check whether the named button may be successfully unsubscribed.
- Delete the requested button name from the internal list of subscribed items.
- Respond with one of appropriate result codes to SDL.
Note
- In case HMI does not respond SDL's request to subscribe to a button during SDL default timeout
and SDL responds GENERIC_ERROR to mobile app
and then HMI responds that the button has been successfully subscribed,
then SDL sendsUnsubscribeButtonrequest to HMI, so that the application and HMI are in sync. - When an application disconnects unexpectedly, SDL sends
UnsubscribeButtonrequest for all button names subscribed only by the application just disconnected.
Parameters
| Name | Type | Mandatory | Additional |
|---|---|---|---|
| appID | Integer | true | |
| buttonName | Common.ButtonName | true |
Response
Parameters
This RPC has no additional parameter requirements
Sequence Diagrams
JSON Message Examples
Example Request
{ "id": 32, "jsonrpc": "2.0", "method": "Buttons.UnsubscribeButton", "params": { "appID": 680015438, "buttonName": "VOLUME_UP" } }
Example Response
{ "id": 32, "jsonrpc": "2.0", "result": { "code": 0, "method": "Buttons.UnsubscribeButton" } }
Example Error
{ "error": { "code": 22, "data": { "method": "Buttons.UnsubscribeButton" }, "message": "An unknown issue occurred" }, "id": 32, "jsonrpc": "2.0" }