Favorites
hub.favorite.set
Connection type: UI
Add device, items, rules to favorites.
request:
{
"method": "hub.favorite.set",
"id": "_ID_",
"params": {
"devices": [
{
"_id": "_DEVICE_ID",
"favorite": false
}
],
"items": [
{
"_id": "_ITEM_ID_"
}
],
"rules": [
{
"_id": "_RULE_ID_",
"favorite": true
}
]
}
}
Filed | Type | Required | Description |
---|---|---|---|
devices (optional) | Array | - | Devices array for chanching favorite state |
items (optional) | Array | - | Items array for chanching favorite state |
rules (optional) | Array | - | Rules array for chanching favorite state |
ARRAY._id | string | + | Object id |
ARRAY.favorite (optional) | bool | - | true add to favorite(By Default). false remove from favorite |
response:
empty result
broadcasts:
Broadcasts | Description |
---|---|
hub.favorite.added | informs about add to favorite |
hub.favorite.removed | informs about remove from favorite |
hub.favorite.list
Connection type: UI
Get list of favorites devices.
request:
{
"method": "hub.favorite.list",
"id": "_ID_",
"params": {
"request": [
"devices",
"items",
"rules"
]
}
}
Filed | Type | Required | Description |
---|---|---|---|
request | Array | - | Array of requesting data. Possible values: devices , items , rules . |
response:
{
"error": null,
"id": "_ID_",
"result": {
"favorites": {
"devices": [_DEVICE_ID_],
"items": [_ITEM_ID_],
"rules": [_RULE_ID_]
}
}
}
Filed | Description |
---|---|
result.favorites.devices (optional) | Array of favorite Devices Ids |
result.favorites.items (optional) | Array of favorite Items Ids |
result.favorites.rules (optional) | Array of favorite Rules Ids |