Web API requests on sillysky.net

CRecordWebAddClassesToElement

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

The message CRecordWebAddClassesToElement adds classes to an HTML element.

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

{
  "id": "03e06095-b433-4411-b7e8-ee796265bd08",
  "name": "WEB_ADD_CLASSES_TO_ELEMENT",
  "description": "Add classes to an HTML element.",
  "slots": [
    {
      "key": "1",
      "name": "SELECTOR",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The selector."
    },
    {
      "key": "2",
      "name": "CLASS",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The class to add."
    },
    {
      "key": "3",
      "name": "CLASSES",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING_ARRAY",
      "description": "The classes to add."
    }
  ]
}

Arguments

SELECTOR : A selector for identifying the HTML element, e.g. #id_my_element for an ID or .my_class for a class. Several elements can be changed at once.
CLASS : An HTML class to be added to the element. Use this slot if only one class is to be added.
CLASSES : An array of HTML classes to be added to the element.

Usage with the helper class CWebApi

The easiest way is to call the corresponding method in the CWebApi class. The use of the class is described there.

CRecordWebAddFirstChild: Insert a Child Element at the Beginning of an HTML Element

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

since version 2.5

The message CRecordWebAddFirstChild is used to insert a new child element at the beginning of the list of child elements of an existing HTML element (the parent element) in the DOM structure.

This feature is part of the RemoteSkin Web API for DOM manipulation and has been available since version 2.5. The associated logic is implemented within the plugin NY_RemoteSkinWebProtocolAPI.

Message Structure (JSON)

The message is identified under the name WEB_ADD_FIRST_CHILD. It requires two mandatory slots to define the target and the content to be inserted:

CRecordWebAddScript

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

The message CRecordWebAddScript adds a JavaScript to the website.

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

{
  "id": "ebbe16ee-3f96-4068-ae8f-17cfd63f7c63",
  "name": "WEB_ADD_SCRIPT",
  "description": "Add a script.",
  "slots": [
    {
      "key": "1",
      "name": "ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The script ID."
    },
    {
      "key": "2",
      "name": "CONTENT",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "Optional: The content of the script."
    },
    {
      "key": "3",
      "name": "SRC",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "Optional: The source url of the script."
    }
  ]
}

Arguments

ID : The ID of the script ensures that it can be removed when it is no longer needed.
CONTENT : Either: the content of a Javascript file
SRC : Or: the path to a Javascript file

Usage with the helper class CWebApi

The easiest way is to call the corresponding method in the CWebApi class. The use of the class is described there.

CRecordWebAddStyleSheet

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

The message CRecordWebAddStyleSheet adds a stylesheet to the web page.

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

{
  "id": "ae327d0d-989e-4431-a8ea-285d437c254f",
  "name": "WEB_ADD_STYLE_SHEET",
  "description": "Add a stylesheet.",
  "slots": [
    {
      "key": "1",
      "name": "ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The style sheet ID."
    },
    {
      "key": "2",
      "name": "CONTENT",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The content of the style sheet."
    }
  ]
}

Arguments

ID :The ID of the stylesheet. It is required to remove the stylesheet again later.
CONTENT :The content of the stylesheet (the rules).

Usage with the helper class CWebApi

The easiest way is to call the corresponding method in the CWebApi class. The use of the class is described there.

CRecordWebAddTableRowListener

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

The message CRecordWebAddTableRowListener adds a listener to each row of a table.

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

{
  "id": "9e65346d-7510-4c78-9464-ee6738582a2c",
  "name": "WEB_ADD_TABLE_ROW_LISTENER",
  "description": "Adds a listener to a table row. When the table row is clicked, the data of the row is sent with the message WEB_NOTIFY_TABLE_ROW_CLICKED.",
  "slots": [
    {
      "key": "1",
      "name": "ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The ID of the table."
    }
  ]
}

When the table row is clicked, the data of the row is sent with the message CRecordWebNotifyTableRowClicked.

CRecordWebAlert

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

The message CRecordWebAlert displays the Javascript message box.

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

{
  "id": "a1b4984f-7582-45ce-a292-d7e86732f4f8",
  "name": "WEB_ALERT",
  "description": "Show a message.",
  "slots": [
    {
      "key": "1",
      "name": "MESSAGE",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The message to show."
    }
  ]
}

Arguments

MESSAGE : The message to display.

Usage with the helper class CWebApi

The easiest way is to call the corresponding method in the CWebApi class. The use of the class is described there.

CRecordWebListenOnClick1

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

The message CRecordWebListenOnClick1 adds a click listener to an HTML element.
If the element is clicked, the elements of the ID array provided are searched for and their values are returned using the CRecordWebNotifyClick1 message.

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

{
  "id": "85b88b65-17ca-4195-b991-8e6ad1693a09",
  "name": "WEB_LISTEN_ON_CLICK1",
  "description": "Listen for onClick and fetch widget values.",
  "slots": [
    {
      "key": "1",
      "name": "ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The widget ID to listen for."
    },
    {
      "key": "2",
      "name": "WIDGET_IDS",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING_ARRAY",
      "description": "The IDs of widgets from which we wand the current value."
    }
  ]
}

Arguments

ID : The ID of the HTML element that receives a click listener.
WIDGET_IDS: The IDs of the HTML elements that are searched for after a click and whose values are returned.

Usage with the helper class CWebApi

The easiest way is to call the corresponding method in the CWebApi class. The use of the class is described there.

CRecordWebListenOnClick2

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

The message CRecordWebListenOnClick2 adds a click listener to a series of HTML elements.

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

{
  "id": "e0a0cfd5-efdc-4b55-b9dd-0217195d0ff5",
  "name": "WEB_LISTEN_ON_CLICK2",
  "description": "Listen for onClick and deliver ids.",
  "slots": [
    {
      "key": "1",
      "name": "IDS",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING_ARRAY",
      "description": "The ids of the widgets to monitor."
    }
  ]
}

Arguments

IDS : An array of IDs of HTML elements that should all be assigned a click listener.

Usage with the helper class CWebApi

The easiest way is to call the corresponding method in the CWebApi class. The use of the class is described there.

CRecordWebLoadImage

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

The CRecordWebLoadImage message loads an image file from a node's The File Store API. If the image is available in the The File Store API of the local node (the web server), the specified HTML element will be updated.

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

{
  "id": "484ecbf3-636f-4bff-8571-aa9fbc215ff7",
  "name": "WEB_LOAD_IMAGE",
  "description": "Load an image and update the HTML element after loading.",
  "slots": [
    {
      "key": "1",
      "name": "RELATIVE_PATH",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The relative path of the image."
    },
    {
      "key": "2",
      "name": "ELEMENT_ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The ID of the element to update."
    }
  ]
}

Arguments

RELATIVE_PATH : All files in a FileStore are identified by a relative path.
Example : “/app/MyApp/images/goofy.png”

CRecordWebOpenNewTab

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

The message CRecordWebOpenNewTab opens a new tab in the browser.

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

{
  "id": "59a20942-af1b-43c1-ade6-e8a2f60e69aa",
  "name": "WEB_OPEN_NEW_TAB",
  "description": "Opens a new tab in the browser with this URL.",
  "slots": [
    {
      "key": "1",
      "name": "SAME_URL",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "BOOLEAN",
      "description": "True: Uses the URL of the running application."
    },
    {
      "key": "2",
      "name": "URL",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING",
      "description": "Optional: The URL to open."
    },
    {
      "key": "3",
      "name": "PARAMETER",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING_PROPERTIES",
      "description": "Optional: Parameters."
    }
  ]
}

Arguments

SAME_URL : If this argument is true, the same URL is used as that of the running application.
URL: If SAME_URL is false, this URL is used.
PARAMETER: The URL parameters to be provided. Please do not enter a session ID, as this will be inserted automatically. The short version of the session ID is used.

Usage with the helper class CWebApi

The easiest way is to call the corresponding method in the CWebApi class. The use of the class is described there.

CRecordWebRemoveClassesFromElement

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

The message CRecordWebRemoveClassesFromElement removes one or more classes from an HTML element.

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

{
  "id": "8fffd143-dab3-4f96-ac64-6f660bf45cfd",
  "name": "WEB_REMOVE_CLASSES_FROM_ELEMENT",
  "description": "Remove classes from an HTML element.",
  "slots": [
    {
      "key": "1",
      "name": "SELECTOR",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The selector."
    },
    {
      "key": "2",
      "name": "CLASS",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The class to remove."
    },
    {
      "key": "3",
      "name": "CLASSES",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING_ARRAY",
      "description": "The classes to remove."
    }
  ]
}

Arguments

SELECTOR : The selector is used to find the HTML elements to be changed.
Example: ".example". Find more examples here

CRecordWebRemoveElement

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

The message CRecordWebRemoveElement deletes an HTML element.

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

{
  "id": "5d0e42dc-b791-42e8-8652-a642b4bf463c",
  "name": "WEB_REMOVE_ELEMENT",
  "description": "Remove an element.",
  "slots": [
    {
      "key": "1",
      "name": "ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The ID of the element to be removed."
    }
  ]
}

Arguments

ID : The ID of the element to be removed.

Usage with the helper class CWebApi

The easiest way is to call the corresponding method in the CWebApi class. The use of the class is described there.

CRecordWebRemoveScript

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

The CRecordWebRemoveScript message removes a Javascript element.

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

{
  "id": "ab1cc1ee-0062-4d68-b657-3b0dde496eb8",
  "name": "WEB_REMOVE_SCRIPT",
  "description": "Remove a script.",
  "slots": [
    {
      "key": "1",
      "name": "ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The script ID."
    }
  ]
}

Arguments

ID : The ID of the Javascript element. JavaScript elements dynamically added to an HTML page should always have a unique ID to allow their removal later. Additionally, it’s important to consider that other microservices may also embed their JavaScript elements dynamically. Therefore, the ID must be truly unique.

Usage with the helper class CWebApi

The easiest way is to call the corresponding method in the CWebApi class. The use of the class is described there.

CRecordWebRemoveStyleSheet

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

The CRecordWebRemoveStyleSheet message removes a stylesheet.

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

{
  "id": "55bc8f47-c012-4dbb-97e1-62f13a694cf0",
  "name": "WEB_REMOVE_STYLE_SHEET",
  "description": "Remove a stylesheet.",
  "slots": [
    {
      "key": "1",
      "name": "ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The style sheet ID."
    }
  ]
}

Arguments

ID : The ID of the style sheet element. Style sheet elements dynamically added to an HTML page should always have a unique ID to allow their removal later. Additionally, it’s important to consider that other microservices may also embed their style sheet elements dynamically. Therefore, the ID must be truly unique.

Usage with the helper class CWebApi

The easiest way is to call the corresponding method in the CWebApi class. The use of the class is described there.

CRecordWebSendJson

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

The CRecordWebSendJson message sends a JSON text directly to the browser. The message is used to extend the Web API.

Nearly all messages of the RemoteSkin API result in a JSON text being sent to the browser. This JSON text is then used to invoke JavaScript methods. The JavaScript files used by RemoteSkin are available in the source code and can be modified by you. The counterpart, i.e., sending the JSON text to the browser, is handled by this message. This allows you to implement any commands not yet provided by the API.

CRecordWebSetInnerHtml

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

The CRecordWebSetInnerHtml message sets the HTML content (inner HTML) of an element.

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

{
  "id": "a6af1ae5-d752-45e7-9dc9-d048d6f14f80",
  "name": "WEB_SET_INNER_HTML",
  "description": "Insert a HTML text.",
  "slots": [
    {
      "key": "1",
      "name": "ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The widget ID."
    },
    {
      "key": "2",
      "name": "HTML",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The HTML to insert."
    }
  ]
}

Arguments

ID : The ID of the HTML element.
HTML : The new content of the HTML element.

Usage with the helper class CWebApi

The easiest way is to call the corresponding method in the CWebApi class. The use of the class is described there.

CRecordWebSetStylesForElements

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

The CRecordWebSetStylesForElements message sets individual styles for HTML elements.

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

{
  "id": "8a6a97e6-e628-49e4-a8ed-936b82779bff",
  "name": "WEB_SET_STYLES_FOR_ELEMENTS",
  "description": "Set a style for all elements matching the selector.",
  "slots": [
    {
      "key": "1",
      "name": "SELECTOR",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The selector for searching elements, like .myClasses or #myId."
    },
    {
      "key": "2",
      "name": "STYLES",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING_PROPERTIES",
      "description": "The styles to set."
    }
  ]
}

Arguments

SELECTOR : The selector to find HTML elements.
Example: ".example".
Find more examples here

CRecordWebSetValue

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

The CRecordWebSetValue message sets the value of an input element.

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

{
  "id": "a13e429c-b6bd-4566-95b4-b803ada225cb",
  "name": "WEB_SET_VALUE",
  "description": "Set a value of an input element.",
  "slots": [
    {
      "key": "1",
      "name": "ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The id of the element."
    },
    {
      "key": "2",
      "name": "VALUE",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The value to set."
    }
  ]
}

Arguments

ID : The id of the HTML element.
VALUE : The value to set.

Usage with the helper class CWebApi

The easiest way is to call the corresponding method in the CWebApi class. The use of the class is described there.

CRecordWebShowModal

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

The CRecordWebShowModal message shows a modal dialog.

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

{
  "id": "df92f998-f2ad-484c-aac5-5e714bc7996c",
  "name": "WEB_SHOW_MODAL",
  "description": "Show a modal dialog.",
  "slots": [
    {
      "key": "1",
      "name": "ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The id of the dialog."
    }
  ]
}

Arguments

ID : The id of the dialog HTML element (usually a div).

Usage with the helper class CWebApi

The easiest way is to call the corresponding method in the CWebApi class. The use of the class is described there.