Messages API for manipulating the DOM on sillysky.net

CRecordWebDeregisterWidgetOwner

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

Browser messages are always associated with an HTML element ID. If you registered element IDs using the CRecordWebRegisterWidgetOwner message, you need to deregister them when your service is deleted. You can either deregister specific element IDs or all IDs linked to your microservice.

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

{
  "id": "43e176e2-e502-4cce-aedf-1ce5ab35aa0b",
  "name": "WEB_DEREGISTER_WIDGET_OWNER",
  "description": "Deregister a widget owner.",
  "slots": [
    {
      "key": "1",
      "name": "WIDGET_IDS",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING_ARRAY",
      "description": "Optional: The IDs of HTML widgets to deregister.\nIf missing, all widgets for this address will be deregistered."
    }
  ]
}

Usage

Deregister all element IDs

The RemoteSkin target address is also required.

CRecordWebRegisterWidgetOwner

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

The CRecordWebRegisterWidgetOwner message enables the forwarding of notifications from the browser to your microservice. Browser messages are always associated with an HTML element ID. You can register any number of element IDs with your microservice address to receive these events.

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

{
  "id": "738d3f34-a5a0-4431-a9ed-6064d39910cd",
  "name": "WEB_REGISTER_WIDGET_OWNER",
  "description": "Register a target address for a widget.",
  "slots": [
    {
      "key": "1",
      "name": "WIDGET_IDS",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING_ARRAY",
      "description": "The IDs of HTML widgets which belong to the sender."
    }
  ]
}

Usage

Registration

This method registers an array of HTML element IDs in order to receive notifications from the browser for these elements.

CWebApi

Wed, 27 Nov 2024 00:00:00 +0000

This is the documentation of the helper class CWebApi of the RemoteSkin Web API. This class can be used to send messages to the browser with which the DOM tree of the website can be changed.

Usage

You have a target that should send commands to the browser. Create a private field in the target class:

private final CWebApi mWebApi;

Initialize the field (e.g. in the constructor). In any case, you need the target address of the web socket connection.