Skip to content
scalive
Menu
ConnectingLiveReconnectingOffline
GitHub
c

RawFormEvent

class RawFormEvent[+A]

A codec-backed event retained as an explicit low-level escape hatch.

Unlike FormEvent, this has no definition identity, typed address ownership, projection limits, or interaction-aware error visibility. Its raw payload is preserved verbatim.

Parameters

raw

The untrusted payload, exactly as received.

value

The codec's result: the decoded value or its errors.

target

The browser path of the control that triggered the event, when the client reported one.

rawSubmitter

The untrusted submit control the client reported, when available.

recovery

Whether the event is the browser's recovery of the form after a reconnect.

submitted

Whether the event is a submission.

metadata

Additional event metadata supplied by the client protocol.

Defined by scalive.RawFormEvent. View source (scalive/api/src/scalive/forms/FormEvent.scala:92-114)

Methods5

data

def data: FormData

Alias for raw.

Defined by scalive.RawFormEvent.data. View source (scalive/api/src/scalive/forms/FormEvent.scala:102-102)

errors

def errors: FormErrors[Any]

Codec errors, or an empty collection on success.

Defined by scalive.RawFormEvent.errors. View source (scalive/api/src/scalive/forms/FormEvent.scala:111-111)

isValid

def isValid: Boolean

Whether codec decoding succeeded.

Defined by scalive.RawFormEvent.isValid. View source (scalive/api/src/scalive/forms/FormEvent.scala:108-108)

state

def state: RawFormState[A]

Low-level state suitable for APIs that consume RawFormState.

Defined by scalive.RawFormEvent.state. View source (scalive/api/src/scalive/forms/FormEvent.scala:105-105)

valueOption

def valueOption: Option[A]

Decoded value on success.

Defined by scalive.RawFormEvent.valueOption. View source (scalive/api/src/scalive/forms/FormEvent.scala:114-114)

Values7

metadata

val metadata: Map[String, String]

Additional event metadata supplied by the client protocol.

Defined by scalive.RawFormEvent.metadata. View source (scalive/api/src/scalive/forms/FormEvent.scala:99-99)

raw

val raw: FormData

The untrusted payload, exactly as received.

Defined by scalive.RawFormEvent.raw. View source (scalive/api/src/scalive/forms/FormEvent.scala:93-93)

rawSubmitter

val rawSubmitter: Option[RawFormSubmitter]

The untrusted submit control the client reported, when available.

Defined by scalive.RawFormEvent.rawSubmitter. View source (scalive/api/src/scalive/forms/FormEvent.scala:96-96)

recovery

val recovery: Boolean

Whether the event is the browser's recovery of the form after a reconnect.

Defined by scalive.RawFormEvent.recovery. View source (scalive/api/src/scalive/forms/FormEvent.scala:97-97)

submitted

val submitted: Boolean

Whether the event is a submission.

Defined by scalive.RawFormEvent.submitted. View source (scalive/api/src/scalive/forms/FormEvent.scala:98-98)

target

val target: Option[FormPath]

The browser path of the control that triggered the event, when the client reported one.

Defined by scalive.RawFormEvent.target. View source (scalive/api/src/scalive/forms/FormEvent.scala:95-95)

value

val value: util.Either[FormErrors[Any], A]

The codec's result: the decoded value or its errors.

Defined by scalive.RawFormEvent.value. View source (scalive/api/src/scalive/forms/FormEvent.scala:94-94)