Skip to content

Toggle printing, file transfer, and notification features when accessing the HTML5 Display client. These query parameters configure client-side capabilities at connection time, allowing you to disable resource-intensive features (like file transfer) in kiosk environments or enable real-time notifications via an external server.

Serves the HTML5 Display client web interface with feature flag configuration via URL parameters. This is the standardized API version of the root endpoint.

The parameters below control printing, file transfer, and notification behavior. For the full list of configuration parameters, see the main Display client endpoint.

NameInTypeRequiredDescription
printingquerybooleanNoEnable printing support. Default: true
file_transferquerybooleanNoEnable file transfer support. Default: true
notification_server_urlquerystringNoExternal notification server URL for real-time notification integration.
web_notificationsquerybooleanNoEnable browser web notifications (native OS notifications). Default: true
display_notificationsquerybooleanNoShow notifications within display UI. Default: true
notification_connection_typequerystringNoNotification server connection type. Allowed values: websocket, polling. Default: "websocket"

The URL must follow this pattern:

https://{project}-{container}-n-{display}.{node}.containers.hoody.icu/notification-client.js

If not provided, the client attempts to auto-detect from the current hostname pattern by transforming display to n in the URL.

Examples:

  • Manual: ?notification_server_url=https://my-project-container-n-6.sg-sin-1.containers.hoody.icu/notification-client.js
  • Auto-detected from: https://my-project-container-display-6.sg-sin-1.containers.hoody.icu

The notification server (port 3999) provides historical notification retrieval, real-time WebSocket updates, notification icons, and desktop notification triggering.

<!DOCTYPE html>
<html>
<head><title>Hoody Display Client</title></head>
<body>
<!-- Display HTML5 client interface -->
</body>
</html>
Terminal window
curl "https://domain.com/api/v1/display/?printing=false&file_transfer=false&web_notifications=true&display_notifications=true&notification_connection_type=websocket"
const html = await client.display.accessClient({
printing: false,
file_transfer: false,
web_notifications: true,
display_notifications: true,
notification_server_url: "https://my-project-container-n-6.sg-sin-1.containers.hoody.icu/notification-client.js",
notification_connection_type: "websocket"
});