Package org.angular.ts.ng

Interface WebSocketConfig

@JsType(isNative=true, name="ng.WebSocketConfig", namespace="<global>") public interface WebSocketConfig
WebSocket-specific configuration

  • Method Details

    • create

      @JsOverlay static WebSocketConfig create()

    • getEventTypes

      @JsProperty elemental2.core.JsArray<String> getEventTypes()
      Additional EventSource event names to subscribe to

    • getHeartbeatTimeout

      @JsProperty double getHeartbeatTimeout()
      Timeout in milliseconds to detect heartbeat inactivity

    • getMaxRetries

      @JsProperty double getMaxRetries()
      Maximum number of reconnect attempts

    • getOnClose

      @JsProperty WebSocketConfig.OnCloseCallback getOnClose()
      Called when a WebSocket connection closes

    • getOnError

      @JsProperty WebSocketConfig.OnErrorCallback getOnError()
      Called when an error occurs

    • getOnEvent

      @JsProperty WebSocketConfig.OnEventCallback getOnEvent()
      Called with every registered connection message, including custom SSE event types

    • getOnMessage

      @JsProperty WebSocketConfig.OnMessageCallback getOnMessage()
      Called when a message is received

    • getOnOpen

      @JsProperty WebSocketConfig.OnOpenCallback getOnOpen()
      Called when the connection opens

    • getOnProtocolMessage

      @JsProperty WebSocketConfig.OnProtocolMessageCallback getOnProtocolMessage()
      Called when a decoded message uses the realtime protocol shape.

    • getOnReconnect

      @JsProperty WebSocketConfig.OnReconnectCallback getOnReconnect()
      Called when a reconnect attempt happens

    • getProtocols

      @JsProperty elemental2.core.JsArray<String> getProtocols()
      Optional WebSocket subprotocols

    • getRetryDelay

      @JsProperty double getRetryDelay()
      Delay between reconnect attempts in milliseconds

    • getTransformMessage

      @JsProperty WebSocketConfig.TransformMessageCallback getTransformMessage()
      Function to transform incoming messages

    • setEventTypes

      @JsProperty void setEventTypes(elemental2.core.JsArray<String> eventTypes)
      Additional EventSource event names to subscribe to

    • setHeartbeatTimeout

      @JsProperty void setHeartbeatTimeout(double heartbeatTimeout)
      Timeout in milliseconds to detect heartbeat inactivity

    • setMaxRetries

      @JsProperty void setMaxRetries(double maxRetries)
      Maximum number of reconnect attempts

    • setOnClose

      @JsProperty void setOnClose(WebSocketConfig.OnCloseCallback onClose)
      Called when a WebSocket connection closes

    • setOnError

      @JsProperty void setOnError(WebSocketConfig.OnErrorCallback onError)
      Called when an error occurs

    • setOnEvent

      @JsProperty void setOnEvent(WebSocketConfig.OnEventCallback onEvent)
      Called with every registered connection message, including custom SSE event types

    • setOnMessage

      @JsProperty void setOnMessage(WebSocketConfig.OnMessageCallback onMessage)
      Called when a message is received

    • setOnOpen

      @JsProperty void setOnOpen(WebSocketConfig.OnOpenCallback onOpen)
      Called when the connection opens

    • setOnProtocolMessage

      @JsProperty void setOnProtocolMessage(WebSocketConfig.OnProtocolMessageCallback onProtocolMessage)
      Called when a decoded message uses the realtime protocol shape.

    • setOnReconnect

      @JsProperty void setOnReconnect(WebSocketConfig.OnReconnectCallback onReconnect)
      Called when a reconnect attempt happens

    • setProtocols

      @JsProperty void setProtocols(elemental2.core.JsArray<String> protocols)
      Optional WebSocket subprotocols

    • setRetryDelay

      @JsProperty void setRetryDelay(double retryDelay)
      Delay between reconnect attempts in milliseconds

    • setTransformMessage

      @JsProperty void setTransformMessage(WebSocketConfig.TransformMessageCallback transformMessage)
      Function to transform incoming messages