RetainedEffectResult

Artifact: androidx.compose.runtime:runtime-retain

Cmn
```
interface RetainedEffectResult
```

The return type of a built RetainedEffect. This is created in the RetainedEffectScope.onRetire clause and tracks the onRetiredEffect callback for internal usage.

Summary

Public functions
`Unit`	`retire()` Called when the `RetainedEffect` is retired from composition.	Cmn

Public functions

retire

Cmn

Added in 1.10.0-alpha04

fun retire(): Unit

Called when the RetainedEffect is retired from composition. This should call the onRetiredEffect provided to RetainedEffectScope.onRetire.

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2025-09-24 UTC.

WeChat
Follow Android Developers on WeChat
X
Follow @AndroidDev on X
YouTube
Check out Android Developers on YouTube