Skip to content
scalive
Menu
ConnectingLiveReconnectingOffline
GitHub
c

ConnectParam

class ConnectParam[A]

A typed key for one parameter the browser sends when it joins.

Declare each key once and read it with connected.connectParam(key). The browser sends the values given in the LiveSocket params option, such as params: () => ({ timeZone: Intl.DateTimeFormat().resolvedOptions().timeZone }), read with ConnectParam[ZoneId]("timeZone"). Values are untrusted: never base identity or authorization on them.

Parameters

name

The parameter's name. Names starting with _ are reserved by Phoenix and rejected.

Defined by scalive.ConnectParam. View source (scalive/api/src/scalive/lifecycle/ConnectParam.scala:17-20)

Values1

name

val name: String

The parameter's name. Names starting with _ are reserved by Phoenix and rejected.

Defined by scalive.ConnectParam.name. View source (scalive/api/src/scalive/lifecycle/ConnectParam.scala:17-17)