redwood-protocol-guest/app.cash.redwood.protocol.guest/ProtocolBridge

ProtocolBridge

interface ProtocolBridge : EventSink

Exposes a Widget.Children and Widget.Provider whose changes can be captured as a list of Changes to send to a remote frontend. Incoming Events can also be sent to this instance and will be routed to the appropriate handler.

Types

Factory

interface Factory

Properties

provider

abstract val provider: Widget.Provider<Nothing>

The provider of factories of widgets which record property changes and whose children changes are also recorded. You must attach returned widgets to root or the children of a widget in the tree beneath root in order for it to be tracked.

root

abstract val root: Widget.Children<Nothing>

The root of the widget tree onto which provider-produced widgets can be added. Changes to this instance are recorded as changes to Id.Root and ChildrenTag.Root.

Functions

getChangesOrNull

abstract fun getChangesOrNull(): List<Change>?

Returns any changes to root or provider-produced widgets since the last time this function was called. Returns null if no changes occurred.

sendEvent

abstract fun sendEvent(event: Event)