Web API notifications on sillysky.net

CRecordWebIncomingJson

Tue, 09 Dec 2025 00:00:00 +0000

The CRecordWebIncomingJson message is made for extensions to the Web API. Messages that the websocket server does not recognize are sent to interested targets with this message.

All JSON messages sent from the browser containing an unknown command in the cmd field are forwarded to the targets that have registered interest in the element's ID (field: id, see CRecordWebRegisterWidgetOwner).

Messages from the browser always have this format (mandatory field):

{
    "cmd": "onClick2",
    "id": "myElementId",
    "how": "left"
}

The message is part of the RemoteSkin Web API.
The API is located in the plugin NY_RemoteSkinWebProtocolAPI.

CRecordWebNotifyClick1

Tue, 09 Dec 2025 00:00:00 +0000

The CRecordWebNotifyClick1 message is a notification when an element has been clicked.

To receive this message,

a listener must be installed for the HTML element: CRecordWebListenOnClick1
your target address must be linked to the element ID: CRecordWebRegisterWidgetOwner

The message is part of the RemoteSkin Web API.
The API is located in the plugin NY_RemoteSkinWebProtocolAPI.

{
  "id": "64e979ff-d44d-4a83-bdf2-286f6b431c43",
  "name": "WEB_NOTIFY_CLICK1",
  "description": "A widget has been clicked.",
  "slots": [
    {
      "key": "1",
      "name": "ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The widget ID."
    },
    {
      "key": "2",
      "name": "VALUES",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING_PROPERTIES",
      "description": "The widget ids and their values."
    }
  ]
}

Arguments

ID : The ID of the html element to which the message belongs.
VALUES : When setting up the listener, you specified an array of element IDs whose values you want to receive upon a click. These values are provided as a property list, with the element ID as the key and the element's value as the corresponding value.

Usage

CRecordWebNotifyClick2

Tue, 09 Dec 2025 00:00:00 +0000

The CRecordWebNotifyClick2 message is a notification when an html element has been clicked.

To receive this message,

a listener must be installed for the HTML element: CRecordWebListenOnClick2
your target address must be linked to the element ID: CRecordWebRegisterWidgetOwner

The message is part of the RemoteSkin Web API.
The API is located in the plugin NY_RemoteSkinWebProtocolAPI.

{
  "id": "56c079ec-3726-4ccc-9ac1-e42a5b6b450a",
  "name": "WEB_NOTIFY_CLICK2",
  "description": "A widget has been clicked. Deliver the ID of the widget.",
  "slots": [
    {
      "key": "1",
      "name": "ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The id of the widget which has been clicked."
    },
    {
      "key": "2",
      "name": "HOW",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "left, right."
    }
  ]
}

Arguments

ID : The ID of the html element to which the message belongs.
HOW : "left" or "right".

Usage

CRecordWebNotifyTableRowClicked

Tue, 09 Dec 2025 00:00:00 +0000

The CRecordWebNotifyTableRowClicked message is a notification for a click on a table row.

To receive this message,

a listener must be installed for the table: CRecordWebAddTableRowListener
your target address must be linked to the element ID: CRecordWebRegisterWidgetOwner

The message is part of the RemoteSkin Web API.
The API is located in the plugin NY_RemoteSkinWebProtocolAPI.

{
  "id": "cc1224b7-86e7-4467-8b7c-6647e24e3021",
  "name": "WEB_NOTIFY_TABLE_ROW_CLICKED",
  "description": "Notification: A table row has been clicked.",
  "slots": [
    {
      "key": "1",
      "name": "ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The ID of the table."
    },
    {
      "key": "2",
      "name": "DATA",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING_ARRAY",
      "description": "The data of the table row (column 0-n)."
    }
  ]
}

Arguments

ID : The ID of the table element to which the message belongs.
DATA : The data of the table row, from column 0-n.