Generic Message API for web dialogs on sillysky.net

CRecordShowWebDialog

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

The CRecordShowWebDialog message can be used to create and display a dialog that has been deployed as a microservice.

The message is part of the Web Dialog API of RemoteSkin for Web. The API is part of the NY_RemoteSkinWebProtocolAPI plugin.

{
  "id": "d64362ee-b6cb-4dde-97e0-e51c7fbc2b03",
  "name": "SHOW_WEB_DIALOG",
  "description": "Create and show the web dialog.",
  "slots": [
    {
      "key": "1",
      "name": "CLIENT_TARGET_ADDRESS",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "TARGET_ADDRESS",
      "description": "The target address of the client."
    },
    {
      "key": "2",
      "name": "OWNER_TARGET_ADDRESS",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "TARGET_ADDRESS",
      "description": "The target address of the OWNER."
    },
    {
      "key": "3",
      "name": "PARENT_WIDGET_ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The ID of the HTML parent widget."
    },
    {
      "key": "4",
      "name": "PARAMS",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING_PROPERTIES",
      "description": "Optional: unspecified parameters."
    },
    {
      "key": "10",
      "name": "DIALOG_TARGET_ADDRESS",
      "direction": "RESPONSE",
      "presenceConstraint": "OPTIONAL",
      "type": "TARGET_ADDRESS",
      "description": "The target address of the dialog."
    }
  ]
}

Usage

Show the dialog

To start a dialog that has been implemented as a microservice, we need

CRecordWebNotifyDialogDismissed

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

This message is a notification. It states that a web dialog has been ended.

The message is part of the Web Dialog API of RemoteSkin for Web. The API is part of the NY_RemoteSkinWebProtocolAPI plugin.

{
  "id": "93419a92-5055-4a1f-a35b-59a92467764b",
  "name": "WEB_NOTIFY_DIALOG_DISMISSED",
  "description": "The web dialog has been dismissed.",
  "slots": [
    {
      "key": "1",
      "name": "MICROSERVICE_ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "ID",
      "description": "The micro service ID"
    },
    {
      "key": "2",
      "name": "REASON",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "INT",
      "description": "0: successfully finished, 1: error, 2: canceled by user, 3: canceled by owner"
    },
    {
      "key": "3",
      "name": "RESULTS",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING_PROPERTIES",
      "description": "Optional: unspecified results."
    }
  ]
}

Usage

The message can be caught if you have created a dialog with the CRecordShowWebDialog message and the dialog has been closed.

CRecordWebDismissDialog

Thu, 23 Oct 2025 00:00:00 +0000

By sending the CRecordWebDismissDialog message, open web dialogs can be terminated programmatically.

The message is part of the Web Dialog API of RemoteSkin for Web. The API is part of the NY_RemoteSkinWebProtocolAPI plugin.

{
  "id": "66da8a3a-48c9-4da1-a1f2-cea0f006431b",
  "name": "WEB_DISMISS_DIALOG",
  "description": "Dismiss the web dialog.",
  "slots": [
  ]
}

Usage

The target address of the dialog is required. This is obtained in the response of the message for starting the dialog.

void dismissDialog(@NotNull final CTargetAddress aAddress) throws CException
{
    final CEnvelope env = CEnvelope.forSingleTarget(aAddress);
    final CRecord record = CRecordWebDismissDialog.create();
    sendNotification(env,
                     record);
}

CWebDialogApi

Mon, 25 Nov 2024 00:00:00 +0000

This is a helper class. It is used to display and handle web dialogs. It is located in the plugin NY_RemoteSkinWebProtocolAPI.

Constructor

The constructor requires your target, as the messages are sent to the microservice with this target. This means that the microservice also receives your target address and can send messages to your target.

The second parameter is the client address, or more precisely the address of the WebSocketServer that has the connection to the browser. This allows the microservice to directly manipulate the DOM tree in the browser and receive events from the browser.

Generic Message API for web dialogs on sillysky.net

CRecordShowWebDialog

Usage

Show the dialog

CRecordWebNotifyDialogDismissed

Usage

CRecordWebDismissDialog

Usage

See also:

CWebDialogApi

Constructor