redwood-treehouse-host/app.cash.redwood.treehouse

Package-level declarations

Types

ChangeListRenderer

class ChangeListRenderer<W : Any>(json: Json)

Renders a SnapshotChangeList into a target view by creating all of the widgets and assigning their properties.

@ObjCName(name = "Content", exact = true)

interface Content

A UI built as an interactive widget tree, that may or may not be actively running, or bound to an on-screen display.

@ObjCName(name = "Crashed", exact = true)

interface Crashed<W : Any> : Widget<W>

DynamicContentWidgetFactory

@ObjCName(name = "DynamicContentWidgetFactory", exact = true)

interface DynamicContentWidgetFactory<W : Any>

@ObjCName(name = "EventListener", exact = true)

open class EventListener

@ObjCName(name = "Loading", exact = true)

interface Loading<W : Any> : Widget<W>

MemoryStateStore

class MemoryStateStore : StateStore

A simple in-memory state store.

interface StateStore

All functions are invoked on the UI dispatcher.

@ObjCName(name = "TreehouseApp", exact = true)

abstract class TreehouseApp<A : AppService> : AutoCloseable

Manages the Zipline runtimes that run the code to power on-screen views.

TreehouseContentSource

@ObjCName(name = "TreehouseContentSource", exact = true)

fun interface TreehouseContentSource<A : AppService>

TreehouseDispatchers

@ObjCName(name = "TreehouseDispatchers", exact = true)

interface TreehouseDispatchers : AutoCloseable

One of the trickiest things Treehouse needs to do is balance its two dispatchers:

TreehouseLayout

open class TreehouseLayout(context: Context, val widgetSystem: TreehouseView.WidgetSystem<View>, androidOnBackPressedDispatcher: OnBackPressedDispatcher, val dynamicContentWidgetFactory: DynamicContentWidgetFactory<View> = EmptyDynamicContentWidgetFactory(context)) : RedwoodLayout, TreehouseView<View>

TreehouseUIView

open class TreehouseUIView(val widgetSystem: TreehouseView.WidgetSystem<UIView>, val dynamicContentWidgetFactory: DynamicContentWidgetFactory<UIView>) : RedwoodUIView, TreehouseView<UIView>

@ObjCName(name = "TreehouseView", exact = true)

interface TreehouseView<W : Any> : RedwoodView<W>

Functions

fun <W : Any> Content.bindWhenReady(view: TreehouseView<W>): Closeable

Binds this content to view whenever the view is ready for content. The content will bind and unbind as this view is attached and detached from the UI.

fun <A : AppService, W : Any> TreehouseContentSource<A>.bindWhenReady(view: TreehouseView<W>, app: TreehouseApp<A>): Closeable

TreehouseAppFactory

fun TreehouseAppFactory(context: Context, httpClient: ZiplineHttpClient, manifestVerifier: ManifestVerifier, embeddedFileSystem: FileSystem? = null, embeddedDir: Path? = null, cacheName: String = "zipline", cacheMaxSizeInBytes: Long = 50L * 1024L * 1024L, loaderEventListener: LoaderEventListener = LoaderEventListener.None, concurrentDownloads: Int = 8, stateStore: StateStore = MemoryStateStore(), leakDetector: LeakDetector = LeakDetector.none()): TreehouseApp.Factory

fun TreehouseAppFactory(context: Context, httpClient: OkHttpClient, manifestVerifier: ManifestVerifier, embeddedFileSystem: FileSystem? = null, embeddedDir: Path? = null, cacheName: String = "zipline", cacheMaxSizeInBytes: Long = 50L * 1024L * 1024L, loaderEventListener: LoaderEventListener = LoaderEventListener.None, concurrentDownloads: Int = 8, stateStore: StateStore = MemoryStateStore(), leakDetector: LeakDetector = LeakDetector.none()): TreehouseApp.Factory

fun TreehouseAppFactory(httpClient: ZiplineHttpClient, manifestVerifier: ManifestVerifier, embeddedFileSystem: FileSystem? = null, embeddedDir: Path? = null, cacheName: String = "zipline", cacheMaxSizeInBytes: Long = 50L * 1024L * 1024L, concurrentDownloads: Int = 8, loaderEventListener: LoaderEventListener = LoaderEventListener.None, stateStore: StateStore = MemoryStateStore(), leakDetector: LeakDetector = LeakDetector.none()): TreehouseApp.Factory