Skip to content
scalive
Menu
ConnectingLiveReconnectingOffline
GitHub
c

LiveEncodableRouteParamsBuilder

class LiveEncodableRouteParamsBuilder[A, Params] extends LiveRouteParamsBuilder[A, Params]

Defined by scalive.LiveEncodableRouteParamsBuilder. View source (scalive/api/src/scalive/routing/LiveRouting.scala:1046-1113)

Methods5

guardConnectedTurns

def guardConnectedTurns[Result <: Unit](guard: Any => zio.IO[LiveConnectedTurnFailure, Result]): LiveEncodableRouteParamsBuilder[A, Params]

Appends a policy check before each connected application turn.

Guards at one boundary run in declaration order; session guards run before route guards. The callback receives the context available at this builder. Succeed with Unit to continue, or fail with LiveConnectedTurnFailure for a controlled halt, redirect, reload, or disconnect. Guards are inherited by nested LiveViews and do not run during mount, disconnected rendering, or framework cleanup.

Defined by scalive.LiveEncodableRouteParamsBuilder.guardConnectedTurns. View source (scalive/api/src/scalive/routing/LiveRouting.scala:1082-1092)

location

def location(params: Params): LiveLocation

Defined by scalive.LiveEncodableRouteParamsBuilder.location. View source (scalive/api/src/scalive/routing/LiveRouting.scala:1108-1109)

locationEither

def locationEither(params: Params): Either[LiveLocation.EncodeError, LiveLocation]

Defined by scalive.LiveEncodableRouteParamsBuilder.locationEither. View source (scalive/api/src/scalive/routing/LiveRouting.scala:1111-1112)

mapParams

def mapParams[Params2](decodeParams: Params => Params2)(encodeParams: Params2 => Params): LiveEncodableRouteParamsBuilder[A, Params2]

Defined by scalive.LiveEncodableRouteParamsBuilder.mapParams. View source (scalive/api/src/scalive/routing/LiveRouting.scala:1094-1106)

withConnectedResources

def withConnectedResources[Result <: Unit](initialize: (Any, ConnectedResources) => zio.Task[Result]): LiveEncodableRouteParamsBuilder[A, Params]

Appends connected setup while retaining parameter encoding and location construction.

Defined by scalive.LiveEncodableRouteParamsBuilder.withConnectedResources. View source (scalive/api/src/scalive/routing/LiveRouting.scala:1062-1072)

Values1

codec

val codec: LiveParamsCodec[A, Params]

Defined by scalive.LiveEncodableRouteParamsBuilder.codec. View source (scalive/api/src/scalive/routing/LiveRouting.scala:1048-1048)