HtmlForgeX

API Reference

Class

MonitoringLiveStream

Edit on GitHub
Namespace HtmlForgeX
Assembly HtmlForgeX
Source Containers/Monitoring/MonitoringLiveStream.cs:16
Base Element
Modifiers sealed

Renders accessible connection status chrome for a Server-Sent Events stream and optionally refreshes the page when a payload fingerprint changes.

Inheritance

Remarks

The component owns the generic browser behavior and visual states. Applications only provide their stream URL, update event name, and payload fingerprint property.

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

Methods

public MonitoringLiveStream Connect(String streamUrl) #
Containers/Monitoring/MonitoringLiveStream.cs:31
Returns: MonitoringLiveStream

Sets the Server-Sent Events endpoint.

Parameters

streamUrl System.String requiredposition: 0
Same-origin or CORS-enabled EventSource URL.
public MonitoringLiveStream InitialFingerprint(String fingerprint) #
Containers/Monitoring/MonitoringLiveStream.cs:51
Returns: MonitoringLiveStream

Sets the fingerprint represented by the initially rendered document.

Parameters

fingerprint System.String requiredposition: 0
Initial payload fingerprint, or an empty value when no snapshot is available.
public MonitoringLiveStream Observe(String eventName, String fingerprintProperty) #
Containers/Monitoring/MonitoringLiveStream.cs:41
Returns: MonitoringLiveStream

Selects the event and JSON property used to identify changed payloads.

Parameters

eventName System.String requiredposition: 0
Server-Sent Events event name containing JSON updates.
fingerprintProperty System.String requiredposition: 1
Top-level JSON property containing a stable payload fingerprint.
public MonitoringLiveStream Settings(Action<MonitoringLiveStreamSettings> configure) #
Containers/Monitoring/MonitoringLiveStream.cs:60
Returns: MonitoringLiveStream

Configures reconnect, refresh, state-event, and placement behavior.

Parameters

configure System.Action{HtmlForgeX.MonitoringLiveStreamSettings} requiredposition: 0
Settings callback.
public override String ToString() #
Containers/Monitoring/MonitoringLiveStream.cs:82
Returns: String