HtmlForgeX

API Reference

Class

MonitoringLiveStreamSettings

Namespace HtmlForgeX
Assembly HtmlForgeX
Modifiers sealed

Configures advanced MonitoringLiveStream behavior.

Inheritance

  • Object
  • MonitoringLiveStreamSettings

Usage

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

Accepted by parameters

Methods

public MonitoringLiveStream End() #
Returns: MonitoringLiveStream

Returns the configured component.

public MonitoringLiveStreamSettings InvalidEvent(String eventName) #
Returns: MonitoringLiveStreamSettings

Maps a server event to the invalid-data state.

Parameters

eventName System.String requiredposition: 0
public MonitoringLiveStreamSettings Position(MonitoringLiveStreamPosition position) #
Returns: MonitoringLiveStreamSettings

Sets the typed placement of the status indicator.

Parameters

position HtmlForgeX.MonitoringLiveStreamPosition requiredposition: 0
public MonitoringLiveStreamSettings RefreshPageOnUpdate(Boolean refresh = true) #
Returns: MonitoringLiveStreamSettings

Controls whether a changed fingerprint refreshes the current document.

Parameters

refresh System.Boolean = true optionalposition: 0
public MonitoringLiveStreamSettings ReloadDelay(Int32 milliseconds) #
Returns: MonitoringLiveStreamSettings

Sets the delay before a changed payload refreshes the document.

Parameters

milliseconds System.Int32 requiredposition: 0
public MonitoringLiveStreamSettings WaitingEvent(String eventName) #
Returns: MonitoringLiveStreamSettings

Maps a server event to the waiting-for-data state.

Parameters

eventName System.String requiredposition: 0
public MonitoringLiveStreamSettings WithCredentials(Boolean withCredentials = true) #
Returns: MonitoringLiveStreamSettings

Enables credentialed cross-origin EventSource requests.

Parameters

withCredentials System.Boolean = true optionalposition: 0