PulseContainer

abstract class PulseContainer<Broadcast : PulseBroadcast, Unicast : PulseUnicast>(
    viewModels: List<PulseViewModel<*, *, *, Broadcast, Unicast>>,
    coroutineDispatcher: CoroutineDispatcher = Dispatchers.Default,
)

複数の PulseViewModel インスタンスを調整します。Broadcast の配信、子からの Unicast の処理、View Refresh を提供します。

内部の Unicast 収集には Dispatchers.Default を使います。コンストラクタで別のディスパッチャを渡すこともできます。

メソッド

broadcast(broadcast)

fun broadcast(broadcast: Broadcast)

生成時に登録されたすべての PulseViewModel に broadcast を届けます。各 ViewModel の onReceive() を呼びます。

container.broadcast(AppBroadcast.UserLoggedOut)

---

onReceived(unicast)

open fun onReceived(unicast: Unicast)

登録済みの PulseViewModel が Unicast を発行したときに呼ばれます。PulseContainer は各 ViewModel の unicast Flow を内部で収集します。値をこのフックに転送します。

override fun onReceived(unicast: AppUnicast) {
    when (unicast) {
        AppUnicast.SaveRequested -> broadcast(AppBroadcast.SaveStarted)
    }
}

---

refresh()

fun refresh()

Container の内部キーを進めます。PulseHost 内のすべての PulseContent ブロックが作り直されます。ViewModel の状態は保持され、Compose の状態だけが破棄されます。

container.refresh()

---

close()

fun close()

Container のスコープをキャンセルし、ViewModel からの Unicast の収集を止めます。Container が完全に不要になったときに呼んでください。rememberPulseContainer を使っていれば、所有する ViewModelStore が破棄されるときに自動で呼ばれます。

container.close()

例

class AppContainer(
    viewModels: List<PulseViewModel<*, *, *, AppBroadcast, AppUnicast>>,
) : PulseContainer<AppBroadcast, AppUnicast>(viewModels = viewModels) {
    override fun onReceived(unicast: AppUnicast) {
        when (unicast) {
            AppUnicast.SaveRequested -> broadcast(AppBroadcast.SaveStarted)
        }
    }
}

// 使い方
val container = rememberPulseContainer {
    AppContainer(viewModels = listOf(sidebarViewModel, contentViewModel))
}

// すべての ViewModel へ送る
container.broadcast(AppBroadcast.Sync)

// ビューツリーを再構築する
container.refresh()