# FragmentManager
Artifact: [androidx.fragment:fragment](https://developer.android.com/jetpack/androidx/releases/fragment) [View Source](https://cs.android.com/search?q=file:androidx/fragment/app/FragmentManager.java+class:androidx.fragment.app.FragmentManager) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
*** ** * ** ***
```
abstract class FragmentManager : FragmentResultOwner
```
*** ** * ** ***
Static library support version of the framework's `https://developer.android.com/reference/android/app/FragmentManager.html`. Used to write apps that run on platforms prior to Android 3.0. When running on Android 3.0 or above, this implementation is still used; it does not try to switch to the framework's implementation. See the framework `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager` documentation for a class overview.
Your activity must derive from `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentActivity` to use this. From such an activity, you can acquire the `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager` by calling `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentActivity#getSupportFragmentManager()`.
## Summary
| ### Nested types |
|---|
| `interface https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.BackStackEntry` Representation of an entry on the fragment back stack, as created with `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#addToBackStack(java.lang.String)`. |
| `abstract class https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.FragmentLifecycleCallbacks` Callback interface for listening to fragment state changes that happen within a given FragmentManager. |
| `interface https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.OnBackStackChangedListener` Interface to watch for changes to the back stack. |
| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#POP_BACK_STACK_INCLUSIVE() = 1` Flag for `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStack(java.lang.String,int)` and `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStack(int,int)`: If set, and the name or ID of a back stack entry has been supplied, then all matching entries will be consumed until one that doesn't match is found or the bottom of the stack is reached. |
| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#FragmentManager()()` |
| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#addFragmentOnAttachListener(androidx.fragment.app.FragmentOnAttachListener)(listener: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentOnAttachListener)` Add a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentOnAttachListener` that should receive a call to `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentOnAttachListener#onAttachFragment(androidx.fragment.app.FragmentManager,androidx.fragment.app.Fragment)` when a new Fragment is attached to this FragmentManager. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#addOnBackStackChangedListener(androidx.fragment.app.FragmentManager.OnBackStackChangedListener)( listener: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.OnBackStackChangedListener )` Add a new listener for changes to the fragment back stack. |
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#beginTransaction()()` Start a series of edit operations on the Fragments associated with this FragmentManager. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#clearBackStack(java.lang.String)(name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Clears the back stack previously saved via `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#saveBackStack(java.lang.String)`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#clearFragmentResult(java.lang.String)(requestKey: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Clears the stored result for the given requestKey. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#clearFragmentResultListener(java.lang.String)(requestKey: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Clears the stored `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultListener` for the given requestKey. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#dump(java.lang.String,java.io.FileDescriptor,java.io.PrintWriter,java.lang.String[])( prefix: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, fd: https://developer.android.com/reference/java/io/FileDescriptor.html?, writer: https://developer.android.com/reference/java/io/PrintWriter.html, args: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html? )` Print the FragmentManager's state into the given stream. |
| `java-static https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[enableDebugLogging](https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#enableDebugLogging(boolean))(enabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` **This function is deprecated.** FragmentManager now respects `https://developer.android.com/reference/android/util/Log.html#isLoggable(java.lang.String, int)` for debug logging, allowing you to use `adb shell setprop log.tag.FragmentManager VERBOSE`.
|
| `java-static https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/fragment/app/PredictiveBackControl https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#enablePredictiveBack(boolean)(enabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` Control whether FragmentManager uses the new state predictive back feature that allows seeing the previous Fragment when using gesture back. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/MainThread https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#executePendingTransactions()()` After a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction` is committed with `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#commit()`, it is scheduled to be executed asynchronously on the process's main thread. |
| `java-static F` | ` https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#findFragment(android.view.View)(view: https://developer.android.com/reference/android/view/View.html)` Find a `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment` associated with the given `https://developer.android.com/reference/android/view/View.html`. |
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment?` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#findFragmentById(int)(id: @https://developer.android.com/reference/kotlin/androidx/annotation/IdRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Finds a fragment that was identified by the given id either when inflated from XML or as the container ID when added in a transaction. |
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment?` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#findFragmentByTag(java.lang.String)(tag: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Finds a fragment that was identified by the given tag either when inflated from XML or as supplied when added in a transaction. |
| `java-static https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#findFragmentManager(android.view.View)(view: https://developer.android.com/reference/android/view/View.html)` Recurse up the view hierarchy, looking for a FragmentManager |
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.BackStackEntry` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#getBackStackEntryAt(int)(index: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Return the BackStackEntry at index index in the back stack; entries start index 0 being the bottom of the stack. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#getBackStackEntryCount()()` Return the number of entries currently in the back stack. |
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment?` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#getFragment(android.os.Bundle,java.lang.String)(bundle: https://developer.android.com/reference/android/os/Bundle.html, key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Retrieve the current Fragment instance for a reference previously placed with `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#putFragment(android.os.Bundle,java.lang.String,androidx.fragment.app.Fragment)`. |
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentFactory` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#getFragmentFactory()()` Gets the current `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentFactory` used to instantiate new Fragment instances. |
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-list/index.html)https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#getFragments()()` Get a list of all fragments that are currently added to the FragmentManager. |
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment?` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#getPrimaryNavigationFragment()()` Return the currently active primary navigation fragment for this FragmentManager. |
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/strictmode/FragmentStrictMode.Policy?` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#getStrictModePolicy()()` Returns the current policy for this FragmentManager. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#isDestroyed()()` Returns true if the final `https://developer.android.com/reference/android/app/Activity.html#onDestroy()` call has been made on the FragmentManager's Activity, so this instance is now dead. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#isStateSaved()()` Returns `true` if the FragmentManager's state has already been saved by its host. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#onContainerAvailable(androidx.fragment.app.FragmentContainerView)(container: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentContainerView)` Callback for when the `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentContainerView` becomes available in the view hierarchy and the fragment manager can add the fragment view to its hierarchy. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStack()()` Pop the top state off the back stack. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStack(int,int)(id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, flags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Pop all back stack states up to the one with the given identifier. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStack(java.lang.String,int)(name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?, flags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Pop the last fragment transition from the manager's fragment back stack. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/MainThread https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStackImmediate()()` Like `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStack()`, but performs the operation immediately inside of the call. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStackImmediate(int,int)(id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, flags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Like `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStack(int,int)`, but performs the operation immediately inside of the call. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/MainThread https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStackImmediate(java.lang.String,int)(name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?, flags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Like `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStack(java.lang.String,int)`, but performs the operation immediately inside of the call. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#putFragment(android.os.Bundle,java.lang.String,androidx.fragment.app.Fragment)(bundle: https://developer.android.com/reference/android/os/Bundle.html, key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, fragment: https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment)` Put a reference to a fragment in a Bundle. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#registerFragmentLifecycleCallbacks(androidx.fragment.app.FragmentManager.FragmentLifecycleCallbacks,boolean)( cb: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.FragmentLifecycleCallbacks, recursive: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html )` Registers a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.FragmentLifecycleCallbacks` to listen to fragment lifecycle events happening in this FragmentManager. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#removeFragmentOnAttachListener(androidx.fragment.app.FragmentOnAttachListener)(listener: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentOnAttachListener)` Remove a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentOnAttachListener` that was previously added via `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#addFragmentOnAttachListener(androidx.fragment.app.FragmentOnAttachListener)`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#removeOnBackStackChangedListener(androidx.fragment.app.FragmentManager.OnBackStackChangedListener)( listener: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.OnBackStackChangedListener )` Remove a listener that was previously added with `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#addOnBackStackChangedListener(androidx.fragment.app.FragmentManager.OnBackStackChangedListener)`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#restoreBackStack(java.lang.String)(name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Restores the back stack previously saved via `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#saveBackStack(java.lang.String)`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#saveBackStack(java.lang.String)(name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Save the back stack. |
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment.SavedState?` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#saveFragmentInstanceState(androidx.fragment.app.Fragment)(fragment: https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment)` Save the current instance state of the given Fragment. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#setFragmentFactory(androidx.fragment.app.FragmentFactory)(fragmentFactory: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentFactory)` Set a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentFactory` for this FragmentManager that will be used to create new Fragment instances from this point onward. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#setFragmentResult(java.lang.String,android.os.Bundle)(requestKey: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, result: https://developer.android.com/reference/android/os/Bundle.html)` Sets the given result for the requestKey. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#setFragmentResultListener(java.lang.String,androidx.lifecycle.LifecycleOwner,androidx.fragment.app.FragmentResultListener)( requestKey: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, lifecycleOwner: https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner, listener: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultListener )` Sets the `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultListener` for a given requestKey. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#setStrictModePolicy(androidx.fragment.app.strictmode.FragmentStrictMode.Policy)(policy: https://developer.android.com/reference/kotlin/androidx/fragment/app/strictmode/FragmentStrictMode.Policy?)` Sets the policy for what actions should be detected, as well as the penalty if such actions occur. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#toString()()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#unregisterFragmentLifecycleCallbacks(androidx.fragment.app.FragmentManager.FragmentLifecycleCallbacks)( cb: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.FragmentLifecycleCallbacks )` Unregisters a previously registered `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.FragmentLifecycleCallbacks`. |
| ### Extension functions |
|---|---|
| `inline https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#(androidx.fragment.app.FragmentManager).commit(kotlin.Boolean,kotlin.Function1)(allowStateLoss: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, body: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` Run `https://developer.android.com/reference/kotlin/androidx/fragment/app/package-summary#(androidx.fragment.app.FragmentManager).commit(kotlin.Boolean,kotlin.Function1)` in a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction` which is automatically committed if it completes without exception. |
| `inline https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/MainThread https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#(androidx.fragment.app.FragmentManager).commitNow(kotlin.Boolean,kotlin.Function1)(allowStateLoss: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, body: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` Run `https://developer.android.com/reference/kotlin/androidx/fragment/app/package-summary#(androidx.fragment.app.FragmentManager).commitNow(kotlin.Boolean,kotlin.Function1)` in a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction` which is automatically committed if it completes without exception. |
| `inline https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.[transaction](https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#(androidx.fragment.app.FragmentManager).transaction(kotlin.Boolean,kotlin.Boolean,kotlin.Function1))( now: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, allowStateLoss: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, body: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html )` **This function is deprecated.** Use commit { .. } or commitNow { .. } extensions |
## Constants
### POP_BACK_STACK_INCLUSIVE
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
const val POP_BACK_STACK_INCLUSIVE = 1: Int
```
Flag for `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStack(java.lang.String,int)` and `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStack(int,int)`: If set, and the name or ID of a back stack entry has been supplied, then all matching entries will be consumed until one that doesn't match is found or the bottom of the stack is reached. Otherwise, all entries up to but not including that entry will be removed.
## Public constructors
### FragmentManager
Added in 1.1.0
```
FragmentManager()
```
## Public functions
### addFragmentOnAttachListener
Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.3.0)
```
fun addFragmentOnAttachListener(listener: FragmentOnAttachListener): Unit
```
Add a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentOnAttachListener` that should receive a call to `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentOnAttachListener#onAttachFragment(androidx.fragment.app.FragmentManager,androidx.fragment.app.Fragment)` when a new Fragment is attached to this FragmentManager.
| Parameters |
|---|---|
| `listener: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentOnAttachListener` | Listener to add |
### addOnBackStackChangedListener
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun addOnBackStackChangedListener(
listener: FragmentManager.OnBackStackChangedListener
): Unit
```
Add a new listener for changes to the fragment back stack.
### beginTransaction
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun beginTransaction(): FragmentTransaction
```
Start a series of edit operations on the Fragments associated with this FragmentManager.
Note: A fragment transaction can only be created/committed prior to an activity saving its state. If you try to commit a transaction after `https://developer.android.com/reference/kotlin/androidx/activity/ComponentActivity#onSaveInstanceState(android.os.Bundle)` (and prior to a following `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentActivity#onStart()` or `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentActivity#onResume()`, you will get an error. This is because the framework takes care of saving your current fragments in the state, and if changes are made after the state is saved then they will be lost.
### clearBackStack
Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.4.0)
```
fun clearBackStack(name: String): Unit
```
Clears the back stack previously saved via `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#saveBackStack(java.lang.String)`. This will result in all of the transactions that made up that back stack to be thrown away, thus destroying any fragments that were added through those transactions. All state of those fragments will be cleared as part of this process. If no state was previously saved with the given name, this operation does nothing.
This function is asynchronous -- it enqueues the request to clear, but the action will not be performed until the application returns to its event loop.
| Parameters |
|---|---|
| `name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The name of the back stack previously saved by `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#saveBackStack(java.lang.String)`. |
### clearFragmentResult
```
fun clearFragmentResult(requestKey: String): Unit
```
Clears the stored result for the given requestKey. This clears any result that was previously set via `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultOwner#setFragmentResult(java.lang.String,android.os.Bundle)` that hasn't yet been delivered to a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultListener`.
| Parameters |
|---|---|
| `requestKey: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | key used to identify the result |
### clearFragmentResultListener
```
fun clearFragmentResultListener(requestKey: String): Unit
```
Clears the stored `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultListener` for the given requestKey. This clears any `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultListener` that was previously set via `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultOwner#setFragmentResultListener(java.lang.String,androidx.lifecycle.LifecycleOwner,androidx.fragment.app.FragmentResultListener)`.
| Parameters |
|---|---|
| `requestKey: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | key used to identify the result |
### dump
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun dump(
prefix: String,
fd: FileDescriptor?,
writer: PrintWriter,
args: Array?
): Unit
```
Print the FragmentManager's state into the given stream.
| Parameters |
|---|---|
| `prefix: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | Text to print at the front of each line. |
| `fd: https://developer.android.com/reference/java/io/FileDescriptor.html?` | The raw file descriptor that the dump is being sent to. |
| `writer: https://developer.android.com/reference/java/io/PrintWriter.html` | A PrintWriter to which the dump is to be set. |
| `args: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html?` | Additional arguments to the dump request. |
### enableDebugLogging
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0) Deprecated in [1.2.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.2.0)
```
java-static fun [enableDebugLogging](https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#enableDebugLogging(boolean))(enabled: Boolean): Unit
```
> [!CAUTION]
> **This function is deprecated.**
>
> FragmentManager now respects `https://developer.android.com/reference/android/util/Log.html#isLoggable(java.lang.String, int)` for debug logging, allowing you to use `adb shell setprop log.tag.FragmentManager VERBOSE`.
Control whether the framework's internal fragment manager debugging logs are turned on. If enabled, you will see output in logcat as the framework performs fragment operations.
| See also |
|---|---|
| `https://developer.android.com/reference/android/util/Log.html#isLoggable(java.lang.String, int)` | |
### enablePredictiveBack
Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.7.0)
```
@PredictiveBackControl
java-static fun enablePredictiveBack(enabled: Boolean): Unit
```
Control whether FragmentManager uses the new state predictive back feature that allows seeing the previous Fragment when using gesture back.
This should only be changed **before** any fragment transactions are done (i.e., in your `Application` class or prior to `super.onCreate()` in every activity).
| Parameters |
|---|---|
| `enabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether predictive back should be enabled. |
### executePendingTransactions
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
@MainThread
fun executePendingTransactions(): Boolean
```
After a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction` is committed with `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#commit()`, it is scheduled to be executed asynchronously on the process's main thread. If you want to immediately executing any such pending operations, you can call this function (only from the main thread) to do so. Note that all callbacks and other related behavior will be done from within this call, so be careful about where this is called from.
If you are committing a single transaction that does not modify the fragment back stack, strongly consider using `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#commitNow()` instead. This can help avoid unwanted side effects when other code in your app has pending committed transactions that expect different timing.
This also forces the start of any postponed Transactions where `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#postponeEnterTransition()` has been called.
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Returns true if there were any pending transactions to be executed. |
### findFragment
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.2.0)
```
java-static fun findFragment(view: View): F
```
Find a `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment` associated with the given `https://developer.android.com/reference/android/view/View.html`. This method will locate the `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment` associated with this view. This is automatically populated for the View returned by `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)` and its children.
| Parameters |
|---|---|
| `view: https://developer.android.com/reference/android/view/View.html` | the view to search from |
| Returns |
|---|---|
| `F` | the locally scoped `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment` to the given view |
| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException.html` | if the given view does not correspond with a `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment`. |
### findFragmentById
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun findFragmentById(id: @IdRes Int): Fragment?
```
Finds a fragment that was identified by the given id either when inflated from XML or as the container ID when added in a transaction. This first searches through fragments that are currently added to the manager's activity; if no such fragment is found, then all fragments currently on the back stack associated with this ID are searched.
| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment?` | The fragment if found or null otherwise. |
### findFragmentByTag
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun findFragmentByTag(tag: String?): Fragment?
```
Finds a fragment that was identified by the given tag either when inflated from XML or as supplied when added in a transaction. This first searches through fragments that are currently added to the manager's activity; if no such fragment is found, then all fragments currently on the back stack are searched.
If provided a `null` tag, this method returns null.
| Parameters |
|---|---|
| `tag: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | the tag used to search for the fragment |
| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment?` | The fragment if found or null otherwise. |
### findFragmentManager
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.8.0)
```
java-static fun findFragmentManager(view: View): FragmentManager
```
Recurse up the view hierarchy, looking for a FragmentManager
| Parameters |
|---|---|
| `view: https://developer.android.com/reference/android/view/View.html` | the view to search from |
| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager` | The containing `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager` of the given view. |
| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException.html` | if there no Fragment associated with the view and the view's context is not a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentActivity`. |
### getBackStackEntryAt
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun getBackStackEntryAt(index: Int): FragmentManager.BackStackEntry
```
Return the BackStackEntry at index index in the back stack; entries start index 0 being the bottom of the stack.
### getBackStackEntryCount
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun getBackStackEntryCount(): Int
```
Return the number of entries currently in the back stack.
### getFragment
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun getFragment(bundle: Bundle, key: String): Fragment?
```
Retrieve the current Fragment instance for a reference previously placed with `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#putFragment(android.os.Bundle,java.lang.String,androidx.fragment.app.Fragment)`.
| Parameters |
|---|---|
| `bundle: https://developer.android.com/reference/android/os/Bundle.html` | The bundle from which to retrieve the fragment reference. |
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The name of the entry in the bundle. |
| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment?` | Returns the current Fragment instance that is associated with the given reference. |
### getFragmentFactory
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun getFragmentFactory(): FragmentFactory
```
Gets the current `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentFactory` used to instantiate new Fragment instances.
If no factory has been explicitly set on this FragmentManager via `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#setFragmentFactory(androidx.fragment.app.FragmentFactory)`, the FragmentFactory of the `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getParentFragmentManager()` will be returned.
| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentFactory` | the current FragmentFactory |
### getFragments
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun getFragments(): (Mutable)List
```
Get a list of all fragments that are currently added to the FragmentManager. This may include those that are hidden as well as those that are shown. This will not include any fragments only in the back stack, or fragments that are detached or removed.
The order of the fragments in the list is the order in which they were added or attached.
| Returns |
|---|---|
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-list/index.html)https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` | A list of all fragments that are added to the FragmentManager. |
### getPrimaryNavigationFragment
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun getPrimaryNavigationFragment(): Fragment?
```
Return the currently active primary navigation fragment for this FragmentManager. The primary navigation fragment is set by fragment transactions using `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#setPrimaryNavigationFragment(androidx.fragment.app.Fragment)`.
The primary navigation fragment's `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getChildFragmentManager()` will be called first to process delegated navigation actions such as `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStack()` if no ID or transaction name is provided to pop to.
| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment?` | the fragment designated as the primary navigation fragment |
### getStrictModePolicy
Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.4.0)
```
fun getStrictModePolicy(): FragmentStrictMode.Policy?
```
Returns the current policy for this FragmentManager. If no policy is set, returns null.
### isDestroyed
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun isDestroyed(): Boolean
```
Returns true if the final `https://developer.android.com/reference/android/app/Activity.html#onDestroy()` call has been made on the FragmentManager's Activity, so this instance is now dead.
### isStateSaved
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun isStateSaved(): Boolean
```
Returns `true` if the FragmentManager's state has already been saved by its host. Any operations that would change saved state should not be performed if this method returns true. For example, any popBackStack() method, such as `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStackImmediate()` or any FragmentTransaction using `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#commit()` instead of `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#commitAllowingStateLoss()` will change the state and will result in an error.
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | true if this FragmentManager's state has already been saved by its host |
### onContainerAvailable
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.8.0)
```
fun onContainerAvailable(container: FragmentContainerView): Unit
```
Callback for when the `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentContainerView` becomes available in the view hierarchy and the fragment manager can add the fragment view to its hierarchy.
| Parameters |
|---|---|
| `container: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentContainerView` | the container that the active fragment should add their views to |
### popBackStack
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun popBackStack(): Unit
```
Pop the top state off the back stack. This function is asynchronous -- it enqueues the request to pop, but the action will not be performed until the application returns to its event loop.
### popBackStack
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun popBackStack(id: Int, flags: Int): Unit
```
Pop all back stack states up to the one with the given identifier. This function is asynchronous -- it enqueues the request to pop, but the action will not be performed until the application returns to its event loop.
| Parameters |
|---|---|
| `id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | Identifier of the stated to be popped. If no identifier exists, false is returned. The identifier is the number returned by `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#commit()`. The `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#POP_BACK_STACK_INCLUSIVE()` flag can be used to control whether the named state itself is popped. |
| `flags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | Either 0 or `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#POP_BACK_STACK_INCLUSIVE()`. |
### popBackStack
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun popBackStack(name: String?, flags: Int): Unit
```
Pop the last fragment transition from the manager's fragment back stack. This function is asynchronous -- it enqueues the request to pop, but the action will not be performed until the application returns to its event loop.
| Parameters |
|---|---|
| `name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | If non-null, this is the name of a previous back state to look for; if found, all states up to that state will be popped. The `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#POP_BACK_STACK_INCLUSIVE()` flag can be used to control whether the named state itself is popped. If null, only the top state is popped. |
| `flags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | Either 0 or `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#POP_BACK_STACK_INCLUSIVE()`. |
### popBackStackImmediate
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
@MainThread
fun popBackStackImmediate(): Boolean
```
Like `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStack()`, but performs the operation immediately inside of the call. This is like calling `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#executePendingTransactions()` afterwards without forcing the start of postponed Transactions.
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Returns true if there was something popped, else false. |
### popBackStackImmediate
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun popBackStackImmediate(id: Int, flags: Int): Boolean
```
Like `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStack(int,int)`, but performs the operation immediately inside of the call. This is like calling `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#executePendingTransactions()` afterwards without forcing the start of postponed Transactions.
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Returns true if there was something popped, else false. |
### popBackStackImmediate
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
@MainThread
fun popBackStackImmediate(name: String?, flags: Int): Boolean
```
Like `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStack(java.lang.String,int)`, but performs the operation immediately inside of the call. This is like calling `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#executePendingTransactions()` afterwards without forcing the start of postponed Transactions.
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Returns true if there was something popped, else false. |
### putFragment
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun putFragment(bundle: Bundle, key: String, fragment: Fragment): Unit
```
Put a reference to a fragment in a Bundle. This Bundle can be persisted as saved state, and when later restoring `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#getFragment(android.os.Bundle,java.lang.String)` will return the current instance of the same fragment.
| Parameters |
|---|---|
| `bundle: https://developer.android.com/reference/android/os/Bundle.html` | The bundle in which to put the fragment reference. |
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The name of the entry in the bundle. |
| `fragment: https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment` | The Fragment whose reference is to be stored. |
### registerFragmentLifecycleCallbacks
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun registerFragmentLifecycleCallbacks(
cb: FragmentManager.FragmentLifecycleCallbacks,
recursive: Boolean
): Unit
```
Registers a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.FragmentLifecycleCallbacks` to listen to fragment lifecycle events happening in this FragmentManager. All registered callbacks will be automatically unregistered when this FragmentManager is destroyed.
| Parameters |
|---|---|
| `cb: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.FragmentLifecycleCallbacks` | Callbacks to register |
| `recursive: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | true to automatically register this callback for all child FragmentManagers |
### removeFragmentOnAttachListener
Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.3.0)
```
fun removeFragmentOnAttachListener(listener: FragmentOnAttachListener): Unit
```
Remove a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentOnAttachListener` that was previously added via `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#addFragmentOnAttachListener(androidx.fragment.app.FragmentOnAttachListener)`. It will no longer get called when a new Fragment is attached.
| Parameters |
|---|---|
| `listener: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentOnAttachListener` | Listener to remove |
### removeOnBackStackChangedListener
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun removeOnBackStackChangedListener(
listener: FragmentManager.OnBackStackChangedListener
): Unit
```
Remove a listener that was previously added with `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#addOnBackStackChangedListener(androidx.fragment.app.FragmentManager.OnBackStackChangedListener)`.
### restoreBackStack
Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.4.0)
```
fun restoreBackStack(name: String): Unit
```
Restores the back stack previously saved via `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#saveBackStack(java.lang.String)`. This will result in all of the transactions that made up that back stack to be re-executed, thus re-adding any fragments that were added through those transactions. All state of those fragments will be restored as part of this process. If no state was previously saved with the given name, this operation does nothing.
This function is asynchronous -- it enqueues the request to restore, but the action will not be performed until the application returns to its event loop.
| Parameters |
|---|---|
| `name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The name of the back stack previously saved by `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#saveBackStack(java.lang.String)`. |
### saveBackStack
Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.4.0)
```
fun saveBackStack(name: String): Unit
```
Save the back stack. While this functions similarly to `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#popBackStack(java.lang.String,int)`, it **does not** throw away the state of any fragments that were added through those transactions. Instead, the back stack that is saved by this method can later be restored with its state in tact.
This function is asynchronous -- it enqueues the request to pop, but the action will not be performed until the application returns to its event loop.
| Parameters |
|---|---|
| `name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The name set by `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#addToBackStack(java.lang.String)`. |
### saveFragmentInstanceState
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun saveFragmentInstanceState(fragment: Fragment): Fragment.SavedState?
```
Save the current instance state of the given Fragment. This can be used later when creating a new instance of the Fragment and adding it to the fragment manager, to have it create itself to match the current state returned here. Note that there are limits on how this can be used:
- The Fragment must currently be attached to the FragmentManager.
- A new Fragment created using this saved state must be the same class type as the Fragment it was created from.
- The saved state can not contain dependencies on other fragments -- that is it can't use `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#putFragment(android.os.Bundle,java.lang.String,androidx.fragment.app.Fragment)` to store a fragment reference because that reference may not be valid when this saved state is later used. Likewise the Fragment's target and result code are not included in this state.
| Parameters |
|---|---|
| `fragment: https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment` | The Fragment whose state is to be saved. |
| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment.SavedState?` | The generated state. This will be null if there was no interesting state created by the fragment. |
### setFragmentFactory
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun setFragmentFactory(fragmentFactory: FragmentFactory): Unit
```
Set a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentFactory` for this FragmentManager that will be used to create new Fragment instances from this point onward.
The `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getChildFragmentManager()` of all Fragments in this FragmentManager will also use this factory if one is not explicitly set.
| Parameters |
|---|---|
| `fragmentFactory: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentFactory` | the factory to use to create new Fragment instances |
| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#getFragmentFactory()` | |
### setFragmentResult
```
fun setFragmentResult(requestKey: String, result: Bundle): Unit
```
Sets the given result for the requestKey. This result will be delivered to a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultListener` that is called given to `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultOwner#setFragmentResultListener(java.lang.String,androidx.lifecycle.LifecycleOwner,androidx.fragment.app.FragmentResultListener)` with the same requestKey. If no `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultListener` with the same key is set or the Lifecycle associated with the listener is not at least `https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle.State#STARTED`, the result is stored until one becomes available, or `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultOwner#clearFragmentResult(java.lang.String)` is called with the same requestKey.
| Parameters |
|---|---|
| `requestKey: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | key used to identify the result |
| `result: https://developer.android.com/reference/android/os/Bundle.html` | the result to be passed to another fragment |
### setFragmentResultListener
```
fun setFragmentResultListener(
requestKey: String,
lifecycleOwner: LifecycleOwner,
listener: FragmentResultListener
): Unit
```
Sets the `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultListener` for a given requestKey. Once the given `https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner` is at least in the `https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle.State#STARTED` state, any results set by `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultOwner#setFragmentResult(java.lang.String,android.os.Bundle)` using the same requestKey will be delivered to the `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultListener#onFragmentResult(java.lang.String,android.os.Bundle)`. The callback will remain active until the LifecycleOwner reaches the `https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle.State#DESTROYED` state or `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultOwner#clearFragmentResultListener(java.lang.String)` is called with the same requestKey.
| Parameters |
|---|---|
| `requestKey: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | requestKey used to identify the result |
| `lifecycleOwner: https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner` | lifecycleOwner for handling the result |
| `listener: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultListener` | listener for result changes |
### setStrictModePolicy
Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.4.0)
```
fun setStrictModePolicy(policy: FragmentStrictMode.Policy?): Unit
```
Sets the policy for what actions should be detected, as well as the penalty if such actions occur. The `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getChildFragmentManager()` of all Fragments in this FragmentManager will also use this policy if one is not explicitly set. Pass null to clear the policy.
| Parameters |
|---|---|
| `policy: https://developer.android.com/reference/kotlin/androidx/fragment/app/strictmode/FragmentStrictMode.Policy?` | the policy to put into place |
### toString
```
fun toString(): String
```
### unregisterFragmentLifecycleCallbacks
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/fragment#1.1.0)
```
fun unregisterFragmentLifecycleCallbacks(
cb: FragmentManager.FragmentLifecycleCallbacks
): Unit
```
Unregisters a previously registered `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.FragmentLifecycleCallbacks`. If the callback was not previously registered this call has no effect. All registered callbacks will be automatically unregistered when this FragmentManager is destroyed.
| Parameters |
|---|---|
| `cb: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager.FragmentLifecycleCallbacks` | Callbacks to unregister |
## Extension functions
### FragmentManager.commit
Artifact: [androidx.fragment:fragment](https://developer.android.com/jetpack/androidx/releases/fragment) [View Source](https://cs.android.com/search?q=file:androidx/fragment/app/FragmentManager.kt+function:commit)
```
inline fun FragmentManager.commit(allowStateLoss: Boolean = false, body: FragmentTransaction.() -> Unit): Unit
```
Run `https://developer.android.com/reference/kotlin/androidx/fragment/app/package-summary#(androidx.fragment.app.FragmentManager).commit(kotlin.Boolean,kotlin.Function1)` in a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction` which is automatically committed if it completes without exception.
The transaction will be completed by calling `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#commit()` unless `https://developer.android.com/reference/kotlin/androidx/fragment/app/package-summary#(androidx.fragment.app.FragmentManager).commit(kotlin.Boolean,kotlin.Function1)` is set to `true` in which case `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#commitAllowingStateLoss()` will be used.
### FragmentManager.commitNow
Artifact: [androidx.fragment:fragment](https://developer.android.com/jetpack/androidx/releases/fragment) [View Source](https://cs.android.com/search?q=file:androidx/fragment/app/FragmentManager.kt+function:commitNow)
```
@MainThread
inline fun FragmentManager.commitNow(allowStateLoss: Boolean = false, body: FragmentTransaction.() -> Unit): Unit
```
Run `https://developer.android.com/reference/kotlin/androidx/fragment/app/package-summary#(androidx.fragment.app.FragmentManager).commitNow(kotlin.Boolean,kotlin.Function1)` in a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction` which is automatically committed if it completes without exception.
The transaction will be completed by calling `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#commitNow()` unless `https://developer.android.com/reference/kotlin/androidx/fragment/app/package-summary#(androidx.fragment.app.FragmentManager).commitNow(kotlin.Boolean,kotlin.Function1)` is set to `true` in which case `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#commitNowAllowingStateLoss()` will be used.
### FragmentManager.transaction
Artifact: [androidx.fragment:fragment](https://developer.android.com/jetpack/androidx/releases/fragment) [View Source](https://cs.android.com/search?q=file:androidx/fragment/app/FragmentManager.kt+function:transaction)
```
inline fun FragmentManager.[transaction](https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#(androidx.fragment.app.FragmentManager).transaction(kotlin.Boolean,kotlin.Boolean,kotlin.Function1))(
now: Boolean = false,
allowStateLoss: Boolean = false,
body: FragmentTransaction.() -> Unit
): Unit
```
> [!CAUTION]
> **This function is deprecated.**
> Use commit { .. } or commitNow { .. } extensions
Run `https://developer.android.com/reference/kotlin/androidx/fragment/app/package-summary#(androidx.fragment.app.FragmentManager).transaction(kotlin.Boolean,kotlin.Boolean,kotlin.Function1)` in a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction` which is automatically committed if it completes without exception.
One of four commit functions will be used based on the values of `now` and `allowStateLoss`:
```kotlin
| now | allowStateLoss | Method |
| --- | --- | --- |
| false | false | commit() |
| false | true | commitAllowingStateLoss() |
| true | false | commitNow() |
| true | true | commitNowAllowingStateLoss() |
```