# LifecycleStartStopEffectScope

Artifact: [androidx.lifecycle:lifecycle-runtime-compose](https://developer.android.com/jetpack/androidx/releases/lifecycle) [View Source](https://cs.android.com/search?q=file:androidx/lifecycle/compose/LifecycleEffect.kt+class:androidx.lifecycle.compose.LifecycleStartStopEffectScope) Added in [2.7.0](https://developer.android.com/jetpack/androidx/releases/lifecycle#2.7.0) Common/All
- Cmn

  ```
  class LifecycleStartStopEffectScope : LifecycleOwner
  ```

*** ** * ** ***

Receiver scope for `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartEffect.composable#LifecycleStartEffect(kotlin.Any,androidx.lifecycle.LifecycleOwner,kotlin.Function1)` that offers the `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartStopEffectScope#onStopOrDispose(kotlin.Function1)` clause to couple the ON_START effect. This should be the last statement in any call to `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartEffect.composable#LifecycleStartEffect(kotlin.Any,androidx.lifecycle.LifecycleOwner,kotlin.Function1)`.

This scope is also a `https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner` to allow access to the (lifecycle)`https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartStopEffectScope#lifecycle()` within the `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartStopEffectScope#onStopOrDispose(kotlin.Function1)` clause.

## Summary

| ### Public constructors |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartStopEffectScope#LifecycleStartStopEffectScope(androidx.lifecycle.Lifecycle)(lifecycle: https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle)` | Cmn |

| ### Public functions |
|---|---|---|
| `inline https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStopOrDisposeEffectResult` | `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartStopEffectScope#onStopOrDispose(kotlin.Function1)(crossinline onStopOrDisposeEffect: https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` Provide the `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartStopEffectScope#onStopOrDispose(kotlin.Function1)` to the `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartEffect.composable#LifecycleStartEffect(kotlin.Any,androidx.lifecycle.LifecycleOwner,kotlin.Function1)` to run when the observer receives an (ON_STOP)`https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle.Event#ON_STOP` event or must undergo cleanup. | Cmn |

| ### Public properties |
|---|---|---|
| `open https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle` | `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartStopEffectScope#lifecycle()` The lifecycle being observed by this receiver scope | Cmn |

## Public constructors

### LifecycleStartStopEffectScope

Cmn Added in [2.7.0](https://developer.android.com/jetpack/androidx/releases/lifecycle#2.7.0)

```
LifecycleStartStopEffectScope(lifecycle: Lifecycle)
```

| Parameters |
|---|---|
| `lifecycle: https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle` | The lifecycle being observed by this receiver scope |

## Public functions

### onStopOrDispose

Cmn Added in [2.7.0](https://developer.android.com/jetpack/androidx/releases/lifecycle#2.7.0)

```
inline fun onStopOrDispose(crossinline onStopOrDisposeEffect: LifecycleOwner.() -> Unit): LifecycleStopOrDisposeEffectResult
```

Provide the `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartStopEffectScope#onStopOrDispose(kotlin.Function1)` to the `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartEffect.composable#LifecycleStartEffect(kotlin.Any,androidx.lifecycle.LifecycleOwner,kotlin.Function1)` to run when the observer receives an (ON_STOP)`https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle.Event#ON_STOP` event or must undergo cleanup.

## Public properties

### lifecycle

Cmn Added in [2.7.0](https://developer.android.com/jetpack/androidx/releases/lifecycle#2.7.0)

```
open val lifecycle: Lifecycle
```

The lifecycle being observed by this receiver scope