3.6.1 Buttons

Getting button list

Get the current list of available buttons (programmable positions for application start).

URL:

https://{{ip_addr}}/api/v1/homescreen/buttons

HTTP method:

GET

Response code:

Standard HTTP response code, treating syntactic errors.

Response data:

{
    "data": {
        "buttons": [
            {
                "application": {
                    "id": "com.android.documentsui",
                    "name": "File Manager"
                },
                "icon": 6,
                "id": 1,
                "label": "File Manager",
                "position": 1
            },
            {
                "application": {
                    "id": "com.android.browser",
                    "name": "Browser"
                },
                "icon": 3,
                "id": 2,
                "label": "Browser",
                "position": 2
            },
            {
                "application": {
                    "id": "cz.nn.helios_mobile",
                    "name": "2N® IP Mobile"
                },
                "icon": 8,
                "id": 3,
                "label": "Intercoms",
                "position": 3
            },
            {
                "application": {
                    "id": "com.android.gallery3d",
                    "name": "Gallery"
                },
                "icon": 7,
                "id": 4,
                "label": "Gallery",
                "position": 4
            }
        ]
    }
}

Create a new button

URL:

https://{{ip_addr}}/api/v1/homescreen/buttons

HTTP method:

POST

Request body:
{
    "id": "<integer>",
    "position": "<integer>",
    "label": "<string>",
    "icon": "<integer>",
    "application": {
        "id": "<string>",
        "name": "<string>",
        "version": "<string>",
        "installDate": "<string>"
    }
}

Response code:

Standard HTTP response code, treating syntactic errors.

Response data:

{
    "data": {
        "application": {
            "id": "com.android.gallery3d",
            "installDate": "1/1/09",
            "name": "Gallery",
            "version": "1.1.40030 (40030)"
        },
        "icon": 7,
        "id": 6,
        "label": "test",
        "position": 5
    }
}