# GuidedStepSupportFragment

Artifact: [androidx.leanback:leanback](https://developer.android.com/jetpack/androidx/releases/leanback) [View Source](https://cs.android.com/search?q=file:androidx/leanback/app/GuidedStepSupportFragment.java+class:androidx.leanback.app.GuidedStepSupportFragment) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

*** ** * ** ***


```
class GuidedStepSupportFragment : Fragment
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.fragment.app.Fragment](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment) ||
|   | ↳ | [androidx.leanback.app.GuidedStepSupportFragment](https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment) |

*** ** * ** ***

A GuidedStepSupportFragment is used to guide the user through a decision or series of decisions. It is composed of a guidance view on the left and a view on the right containing a list of possible actions.

### Basic Usage

Clients of GuidedStepSupportFragment must create a custom subclass to attach to their Activities. This custom subclass provides the information necessary to construct the user interface and respond to user actions. At a minimum, subclasses should override:

- `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreateGuidance(android.os.Bundle)`, to provide instructions to the user
- `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreateActions(java.util.List<androidx.leanback.widget.GuidedAction>,android.os.Bundle)`, to provide a set of `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction`s the user can take
- `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onGuidedActionClicked(androidx.leanback.widget.GuidedAction)`, to respond to those actions

Clients use following helper functions to add GuidedStepSupportFragment to Activity or FragmentManager:

- `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#addAsRoot(androidx.fragment.app.FragmentActivity,androidx.leanback.app.GuidedStepSupportFragment,int)`, to be called during Activity onCreate, adds GuidedStepSupportFragment as the first Fragment in activity.
- `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#add(androidx.fragment.app.FragmentManager,androidx.leanback.app.GuidedStepSupportFragment)` or `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#add(androidx.fragment.app.FragmentManager,androidx.leanback.app.GuidedStepSupportFragment,int)`, to add GuidedStepSupportFragment on top of existing Fragments or replacing existing GuidedStepSupportFragment when moving forward to next step.
- `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#finishGuidedStepSupportFragments()` can either finish the activity or pop all GuidedStepSupportFragment from stack.
- If app chooses not to use the helper function, it is the app's responsibility to call `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#setUiStyle(int)` to select fragment transition and remember the stack entry where it need pops to.

### Theming and Stylists

GuidedStepSupportFragment delegates its visual styling to classes called stylists. The `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidanceStylist` is responsible for the left guidance view, while the `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionsStylist` is responsible for the right actions view. The stylists use theme attributes to derive values associated with the presentation, such as colors, animations, etc. Most simple visual aspects of GuidanceStylist and GuidedActionsStylist can be customized via theming; see their documentation for more information.

GuidedStepSupportFragments must have access to an appropriate theme in order for the stylists to function properly. Specifically, the fragment must receive , or a theme whose parent is is set to that theme. Themes can be provided in one of three ways:

- The simplest way is to set the theme for the host Activity to the GuidedStep theme or a theme that derives from it.
- If the Activity already has a theme and setting its parent theme is inconvenient, the existing Activity theme can have an entry added for the attribute . If present, this theme will be used by GuidedStepSupportFragment as an overlay to the Activity's theme.
- Finally, custom subclasses of GuidedStepSupportFragment may provide a theme through the `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onProvideTheme()` method. This can be useful if a subclass is used across multiple Activities.

If the theme is provided in multiple ways, the onProvideTheme override has priority, followed by the Activity's theme. (Themes whose parent theme is already set to the guided step theme do not need to set the guidedStepTheme attribute; if set, it will be ignored.)

If themes do not provide enough customizability, the stylists themselves may be subclassed and provided to the GuidedStepSupportFragment through the `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreateGuidanceStylist()` and `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreateActionsStylist()` methods. The stylists have simple hooks so that subclasses may override layout files; subclasses may also have more complex logic to determine styling.

### Guided sequences

GuidedStepSupportFragments can be grouped together to provide a guided sequence. GuidedStepSupportFragments grouped as a sequence use custom animations provided by `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidanceStylist` and `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionsStylist` (or subclasses) during transitions between steps. Clients should use `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#add(androidx.fragment.app.FragmentManager,androidx.leanback.app.GuidedStepSupportFragment)` to place subsequent GuidedFragments onto the fragment stack so that custom animations are properly configured. (Custom animations are triggered automatically when the fragment stack is subsequently popped by any normal mechanism.)

*Note: Currently GuidedStepSupportFragments grouped in this way must all be defined programmatically, rather than in XML. This restriction may be removed in the future.*

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidanceStylist` |   |
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidanceStylist.Guidance` |   |
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction` |   |
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionsStylist` |   |

## Summary

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#EXTRA_UI_STYLE() = "uiStyle"` Fragment argument name for UI style. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ACTIVITY_ROOT() = 2` One possible value of argument `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#EXTRA_UI_STYLE()`. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_DEFAULT() = 0` **This property is deprecated.** Same value as `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_REPLACE()`. <br /> |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ENTRANCE() = 1` Default value for argument `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#EXTRA_UI_STYLE()`. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_REPLACE() = 0` This is the case that we use GuidedStepSupportFragment to replace another existing GuidedStepSupportFragment when moving forward to next step. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#GuidedStepSupportFragment()()` |

| ### Public functions |
|---|---|
| `java-static https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#add(androidx.fragment.app.FragmentManager,androidx.leanback.app.GuidedStepSupportFragment)( fragmentManager: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager, fragment: https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment )` Adds the specified GuidedStepSupportFragment to the fragment stack, replacing any existing GuidedStepSupportFragments in the stack, and configuring the fragment-to-fragment custom transitions. |
| `java-static https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#add(androidx.fragment.app.FragmentManager,androidx.leanback.app.GuidedStepSupportFragment,int)( fragmentManager: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager, fragment: https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment, id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html )` Adds the specified GuidedStepSupportFragment to the fragment stack, replacing any existing GuidedStepSupportFragments in the stack, and configuring the fragment-to-fragment custom transitions. |
| `java-static https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#addAsRoot(androidx.fragment.app.FragmentActivity,androidx.leanback.app.GuidedStepSupportFragment,int)( activity: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentActivity, fragment: https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment, id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html )` Adds the specified GuidedStepSupportFragment as content of Activity; no backstack entry is added so the activity will be dismissed when BACK key is pressed. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#collapseAction(boolean)(withTransition: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` Collapse action which either has a sub actions list or action with `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction#hasEditableActivatorView()` is true. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#collapseSubActions()()` Collapse sub actions list. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#expandAction(androidx.leanback.widget.GuidedAction,boolean)(action: https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction, withTransition: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` Expand a given action with sub actions list or `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction#hasEditableActivatorView()` is true. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#expandSubActions(androidx.leanback.widget.GuidedAction)(action: https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction)` Expand a given action's sub actions list. |
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction?` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#findActionById(long)(id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)` Find GuidedAction by Id. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#findActionPositionById(long)(id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)` Find GuidedAction position in array by Id. |
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction?` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#findButtonActionById(long)(id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)` Find button GuidedAction by Id. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#findButtonActionPositionById(long)(id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)` Find button GuidedAction position in array by Id. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#finishGuidedStepSupportFragments()()` Convenient method to close GuidedStepSupportFragments on top of other content or finish Activity if GuidedStepSupportFragments were started in a separate activity. |
| `https://developer.android.com/reference/android/view/View.html?` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#getActionItemView(int)(position: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Returns the view corresponding to the action at the indicated position in the list of actions for this fragment. |
| `(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/leanback/widget/GuidedAction!>` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#getActions()()` Returns the list of GuidedActions that the user may take in this fragment. |
| `https://developer.android.com/reference/android/view/View.html?` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#getButtonActionItemView(int)(position: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Returns the view corresponding to the button action at the indicated position in the list of actions for this fragment. |
| `(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/leanback/widget/GuidedAction!>` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#getButtonActions()()` Returns the list of button GuidedActions that the user may take in this fragment. |
| `java-static https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment?` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#getCurrentGuidedStepSupportFragment(androidx.fragment.app.FragmentManager)(fm: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager)` Returns the current GuidedStepSupportFragment on the fragment transaction stack. |
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidanceStylist` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#getGuidanceStylist()()` Returns the GuidanceStylist that displays guidance information for the user. |
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionsStylist` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#getGuidedActionsStylist()()` Returns the GuidedActionsStylist that displays the actions the user may take. |
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionsStylist` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#getGuidedButtonActionsStylist()()` Returns the GuidedActionsStylist that displays the button actions the user may take. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#getSelectedActionPosition()()` Returns the position if the currently selected GuidedAction. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#getSelectedButtonActionPosition()()` Returns the position if the currently selected button GuidedAction. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#getUiStyle()()` Read UI style from fragment arguments. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#isExpanded()()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#isFocusOutEndAllowed()()` Returns true if allows focus out of end edge of GuidedStepSupportFragment, false otherwise. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#isFocusOutStartAllowed()()` Returns true if allows focus out of start edge of GuidedStepSupportFragment, false otherwise. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#isSubActionsExpanded()()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#notifyActionChanged(int)(position: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Notify an action has changed and update its UI. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#notifyButtonActionChanged(int)(position: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Notify an button action has changed and update its UI. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreate(android.os.Bundle)(savedInstanceState: https://developer.android.com/reference/android/os/Bundle.html?)` Called to do initial creation of a fragment. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreateActions(java.util.List<androidx.leanback.widget.GuidedAction>,android.os.Bundle)( actions: (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/leanback/widget/GuidedAction!>, savedInstanceState: https://developer.android.com/reference/android/os/Bundle.html? )` Fills out the set of actions available to the user. |
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionsStylist` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreateActionsStylist()()` Creates the presenter used to style the guided actions panel. |
| `https://developer.android.com/reference/android/view/View.html?` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreateBackgroundView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)( inflater: https://developer.android.com/reference/android/view/LayoutInflater.html, container: https://developer.android.com/reference/android/view/ViewGroup.html?, savedInstanceState: https://developer.android.com/reference/android/os/Bundle.html? )` Called by onCreateView to inflate background view. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreateButtonActions(java.util.List<androidx.leanback.widget.GuidedAction>,android.os.Bundle)( actions: (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/leanback/widget/GuidedAction!>, savedInstanceState: https://developer.android.com/reference/android/os/Bundle.html? )` Fills out the set of actions shown at right available to the user. |
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionsStylist` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreateButtonActionsStylist()()` Creates the presenter used to style a sided actions panel for button only. |
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidanceStylist.Guidance` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreateGuidance(android.os.Bundle)(savedInstanceState: https://developer.android.com/reference/android/os/Bundle.html?)` Returns the information required to provide guidance to the user. |
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidanceStylist` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreateGuidanceStylist()()` Creates the presenter used to style the guidance panel. |
| `https://developer.android.com/reference/android/view/View.html?` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)( inflater: https://developer.android.com/reference/android/view/LayoutInflater.html, container: https://developer.android.com/reference/android/view/ViewGroup.html?, savedInstanceState: https://developer.android.com/reference/android/os/Bundle.html? )` Called to have the fragment instantiate its user interface view. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onDestroyView()()` Called when the view previously created by #onCreateView has been detached from the fragment. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onGuidedActionClicked(androidx.leanback.widget.GuidedAction)(action: https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction)` Callback invoked when an action is taken by the user. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onGuidedActionEditCanceled(androidx.leanback.widget.GuidedAction)(action: https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction)` Callback invoked when an action has been canceled editing, for example when user closes IME window by BACK key. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[onGuidedActionEdited](https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onGuidedActionEdited(androidx.leanback.widget.GuidedAction))(action: https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction!)` **This function is deprecated.** Override `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onGuidedActionEditedAndProceed(androidx.leanback.widget.GuidedAction)` and/or `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onGuidedActionEditCanceled(androidx.leanback.widget.GuidedAction)`. <br /> |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onGuidedActionEditedAndProceed(androidx.leanback.widget.GuidedAction)(action: https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction)` Callback invoked when an action has been edited, for example when user clicks confirm button in IME window. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onGuidedActionFocused(androidx.leanback.widget.GuidedAction)(action: https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction)` Callback invoked when an action is focused (made to be the current selection) by the user. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onProvideTheme()()` Returns the theme used for styling the fragment. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onResume()()` Called when the fragment is visible to the user and actively running. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onSaveInstanceState(android.os.Bundle)(outState: https://developer.android.com/reference/android/os/Bundle.html)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance if its process is restarted. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onSubGuidedActionClicked(androidx.leanback.widget.GuidedAction)(action: https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction)` Callback invoked when an action in sub actions is taken by the user. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#openInEditMode(androidx.leanback.widget.GuidedAction)(action: https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction?)` Opens the provided action in edit mode and raises ime. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#popBackStackToGuidedStepSupportFragment(java.lang.Class<?>,int)( guidedStepFragmentClass: https://developer.android.com/reference/java/lang/Class.html<*>, flags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html )` Convenient method to pop to fragment with Given class. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#setActions(java.util.List<androidx.leanback.widget.GuidedAction>)(actions: (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/leanback/widget/GuidedAction!>)` Sets the list of GuidedActions that the user may take in this fragment. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#setActionsDiffCallback(androidx.leanback.widget.DiffCallback<androidx.leanback.widget.GuidedAction>)(diffCallback: https://developer.android.com/reference/kotlin/androidx/leanback/widget/DiffCallback<https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction!>?)` Sets the RecyclerView DiffCallback used when `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#setActions(java.util.List<androidx.leanback.widget.GuidedAction>)` is called. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#setButtonActions(java.util.List<androidx.leanback.widget.GuidedAction>)(actions: (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/leanback/widget/GuidedAction!>)` Sets the list of button GuidedActions that the user may take in this fragment. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#setSelectedActionPosition(int)(position: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Scrolls the action list to the position indicated, selecting that action's view. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#setSelectedButtonActionPosition(int)(position: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Scrolls the action list to the position indicated, selecting that button action's view. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#setUiStyle(int)(style: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Set UI style to fragment arguments. |

| ### Protected functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onAddSharedElementTransition(androidx.fragment.app.FragmentTransaction,androidx.leanback.app.GuidedStepSupportFragment)( ft: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction, disappearing: https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment )` Called when this fragment is added to FragmentTransaction with `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_REPLACE()` (aka when the GuidedStepSupportFragment replacing an existing GuidedStepSupportFragment). |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onProvideFragmentTransitions()()` Called by Constructor to provide fragment transitions. |

### Inherited functions

From [androidx.activity.result.ActivityResultCaller](https://developer.android.com/reference/kotlin/androidx/activity/result/ActivityResultCaller) `abstract https://developer.android.com/reference/kotlin/androidx/activity/result/ActivityResultLauncher<I!>!` `<I, O> https://developer.android.com/reference/kotlin/androidx/activity/result/ActivityResultCaller#registerForActivityResult(androidx.activity.result.contract.ActivityResultContract<I,O>,androidx.activity.result.ActivityResultCallback<O>)(
contract: https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContract<I!, O!>!,
callback: https://developer.android.com/reference/kotlin/androidx/activity/result/ActivityResultCallback<O!>!
)`

Register a request to `https://developer.android.com/reference/android/app/Activity.html#startActivityForResult(android.content.Intent, int)`, designated by the given `https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContract`.
From [android.content.ComponentCallbacks](https://developer.android.com/reference/android/content/ComponentCallbacks.html) `abstract https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/android/content/ComponentCallbacks.html#onConfigurationChanged(android.content.res.Configuration)(p: https://developer.android.com/reference/android/content/res/Configuration.html!)` `abstract https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/android/content/ComponentCallbacks.html#onLowMemory()()`

**This function is deprecated.**
From [androidx.activity.contextaware.ContextAware](https://developer.android.com/reference/kotlin/androidx/activity/contextaware/ContextAware) `abstract https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/activity/contextaware/ContextAware#addOnContextAvailableListener(androidx.activity.contextaware.OnContextAvailableListener)(listener: https://developer.android.com/reference/kotlin/androidx/activity/contextaware/OnContextAvailableListener!)`

Add a new `https://developer.android.com/reference/kotlin/androidx/activity/contextaware/OnContextAvailableListener` for receiving a callback for when this class is associated with a `https://developer.android.com/reference/android/content/Context.html`.
`abstract https://developer.android.com/reference/android/content/Context.html!` `https://developer.android.com/reference/kotlin/androidx/activity/contextaware/ContextAware#peekAvailableContext()()`

Get the `https://developer.android.com/reference/android/content/Context.html` if it is currently available.
`abstract https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/activity/contextaware/ContextAware#removeOnContextAvailableListener(androidx.activity.contextaware.OnContextAvailableListener)(listener: https://developer.android.com/reference/kotlin/androidx/activity/contextaware/OnContextAvailableListener!)`

Remove a `https://developer.android.com/reference/kotlin/androidx/activity/contextaware/OnContextAvailableListener` previously added via `https://developer.android.com/reference/kotlin/androidx/activity/contextaware/ContextAware#addOnContextAvailableListener(androidx.activity.contextaware.OnContextAvailableListener)`.
From [androidx.fragment.app.Fragment](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#addOnContextAvailableListener(androidx.activity.contextaware.OnContextAvailableListener)(listener: https://developer.android.com/reference/kotlin/androidx/activity/contextaware/OnContextAvailableListener)`

Add a new `https://developer.android.com/reference/kotlin/androidx/activity/contextaware/OnContextAvailableListener` for receiving a callback for when this class is associated with a `https://developer.android.com/reference/android/content/Context.html`.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#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<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!>?
)`

Print the Fragments's state into the given stream.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#equals(java.lang.Object)(o: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)`

Subclasses can not override equals().
`https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentActivity?` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getActivity()()`

Return the `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentActivity` this fragment is currently associated with.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getAllowEnterTransitionOverlap()()`

Returns whether the the exit transition and enter transition overlap or not.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getAllowReturnTransitionOverlap()()`

Returns whether the the return transition and reenter transition overlap or not.
`https://developer.android.com/reference/android/os/Bundle.html?` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getArguments()()`

Return the arguments supplied when the fragment was instantiated, if any.
`https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getChildFragmentManager()()`

Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
`https://developer.android.com/reference/android/content/Context.html?` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getContext()()`

Return the `https://developer.android.com/reference/android/content/Context.html` this fragment is currently associated with.
`https://developer.android.com/reference/kotlin/androidx/lifecycle/viewmodel/CreationExtras` `@https://developer.android.com/reference/kotlin/androidx/annotation/CallSuper
https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getDefaultViewModelCreationExtras()()`

The default `https://developer.android.com/reference/kotlin/androidx/lifecycle/viewmodel/CreationExtras` to pass into `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory#create(kotlin.reflect.KClass,androidx.lifecycle.viewmodel.CreationExtras)` when no overriding `https://developer.android.com/reference/kotlin/androidx/lifecycle/viewmodel/CreationExtras` are provided.
`https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getDefaultViewModelProviderFactory()()`

The default `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory` to use when no custom `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory` is provided to the `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider`.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getEnterTransition()()`

Returns the Transition that will be used to move Views into the initial scene.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getExitTransition()()`

Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager?` `[getFragmentManager](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getFragmentManager())()`

**This function is deprecated.**

This has been removed in favor of `getParentFragmentManager()` which throws an `https://developer.android.com/reference/java/lang/IllegalStateException.html` if the FragmentManager is null.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getHost()()`

Return the host object of this fragment.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getId()()`

Return the identifier this fragment is known by.
`https://developer.android.com/reference/android/view/LayoutInflater.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getLayoutInflater()()`

Returns the cached LayoutInflater used to inflate Views of this Fragment.
`https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getLifecycle()()`

The `https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle` of this owner.
`https://developer.android.com/reference/kotlin/androidx/loader/app/LoaderManager` `[getLoaderManager](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getLoaderManager())()`

**This function is deprecated.**

Use `https://developer.android.com/reference/kotlin/androidx/loader/app/LoaderManager#getInstance(T)`.

<br />

`https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment?` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getParentFragment()()`

Returns the parent Fragment containing this Fragment.
`https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getParentFragmentManager()()`

Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getReenterTransition()()`

Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`https://developer.android.com/reference/android/content/res/Resources.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getResources()()`

Return `requireActivity().getResources()`.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `[getRetainInstance](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getRetainInstance())()`

**This function is deprecated.**

Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getReturnTransition()()`

Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`https://developer.android.com/reference/kotlin/androidx/savedstate/SavedStateRegistry` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getSavedStateRegistry()()`

The `https://developer.android.com/reference/kotlin/androidx/savedstate/SavedStateRegistry` owned by this `https://developer.android.com/reference/kotlin/androidx/savedstate/SavedStateRegistryOwner`.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getSharedElementEnterTransition()()`

Returns the Transition that will be used for shared elements transferred into the content Scene.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getSharedElementReturnTransition()()`

Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getString(int)(resId: @https://developer.android.com/reference/kotlin/androidx/annotation/StringRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`

Return a localized string from the application's package's default string table.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getString(int,java.lang.Object...)(resId: @https://developer.android.com/reference/kotlin/androidx/annotation/StringRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, formatArgs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html!>?)`

Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `https://developer.android.com/reference/java/util/Formatter.html` and `https://developer.android.com/reference/java/lang/String.html#format(java.lang.String, java.lang.Object...)`.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getTag()()`

Get the tag name of the fragment, if specified.
`https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment?` `[getTargetFragment](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getTargetFragment())()`

**This function is deprecated.**

Instead of using a target fragment to pass results, use `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#setFragmentResult(java.lang.String,android.os.Bundle)` to deliver results to `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultListener` instances registered by other fragments via `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#setFragmentResultListener(java.lang.String,androidx.lifecycle.LifecycleOwner,androidx.fragment.app.FragmentResultListener)`.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `[getTargetRequestCode](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getTargetRequestCode())()`

**This function is deprecated.**

When using the target fragment replacement of `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#setFragmentResultListener(java.lang.String,androidx.lifecycle.LifecycleOwner,androidx.fragment.app.FragmentResultListener)` and `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#setFragmentResult(java.lang.String,android.os.Bundle)`, consider using `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setArguments(android.os.Bundle)` to pass a `requestKey` if you need to support dynamic request keys.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getText(int)(resId: @https://developer.android.com/reference/kotlin/androidx/annotation/StringRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`

Return a localized, styled CharSequence from the application's package's default string table.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `[getUserVisibleHint](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getUserVisibleHint())()`

**This function is deprecated.**

Use `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#setMaxLifecycle(androidx.fragment.app.Fragment,androidx.lifecycle.Lifecycle.State)` instead.

<br />

`https://developer.android.com/reference/android/view/View.html?` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getView()()`

Get the root view for the fragment's layout (the one returned by `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)`), if provided.
`https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner` `@https://developer.android.com/reference/kotlin/androidx/annotation/MainThread
https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getViewLifecycleOwner()()`

Get a `https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner` that represents the `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getView()` lifecycle.
`https://developer.android.com/reference/kotlin/androidx/lifecycle/LiveData<https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner!>` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getViewLifecycleOwnerLiveData()()`

Retrieve a `https://developer.android.com/reference/kotlin/androidx/lifecycle/LiveData` which allows you to observe the `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getViewLifecycleOwner()`.
`https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelStore` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getViewModelStore()()`

Returns the `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelStore` associated with this Fragment
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#hashCode()()`

Subclasses can not override hashCode().
`java-static https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment` `[instantiate](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#instantiate(android.content.Context,java.lang.String))(context: https://developer.android.com/reference/android/content/Context.html, fname: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`

**This function is deprecated.**

Use `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#getFragmentFactory()` and `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentFactory#instantiate(java.lang.ClassLoader,java.lang.String)`

<br />

`java-static https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment` `[instantiate](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#instantiate(android.content.Context,java.lang.String,android.os.Bundle))(context: https://developer.android.com/reference/android/content/Context.html, fname: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, args: https://developer.android.com/reference/android/os/Bundle.html?)`

**This function is deprecated.**

Use `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#getFragmentFactory()` and `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentFactory#instantiate(java.lang.ClassLoader,java.lang.String)`, manually calling `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setArguments(android.os.Bundle)` on the returned Fragment.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#isAdded()()`

Return true if the fragment is currently added to its activity.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#isDetached()()`

Return true if the fragment has been explicitly detached from the UI.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#isHidden()()`

Return true if the fragment has been hidden.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#isInLayout()()`

Return true if the layout is included as part of an activity view hierarchy via the tag.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#isRemoving()()`

Return true if this fragment is currently being removed from its activity.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#isResumed()()`

Return true if the fragment is in the resumed state.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#isStateSaved()()`

Returns true if this fragment is added and its state has already been saved by its host.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#isVisible()()`

Return true if the fragment is currently visible to the user.
`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/annotation/CallSuper
[onActivityCreated](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onActivityCreated(android.os.Bundle))(savedInstanceState: https://developer.android.com/reference/android/os/Bundle.html?)`

**This function is deprecated.**

use `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onViewCreated(android.view.View,android.os.Bundle)` for code touching the view created by `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)` and `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onCreate(android.os.Bundle)` for other initialization.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[onActivityResult](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onActivityResult(int,int,android.content.Intent))(requestCode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, resultCode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, data: https://developer.android.com/reference/android/content/Intent.html?)`

**This function is deprecated.**

This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContract` and the prebuilt contracts for common intents available in `https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.

<br />

`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/annotation/CallSuper
[onAttach](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onAttach(android.app.Activity))(activity: https://developer.android.com/reference/android/app/Activity.html)`

**This function is deprecated.**

See `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onAttach(android.content.Context)`.

<br />

`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/annotation/CallSuper
https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onAttach(android.content.Context)(context: https://developer.android.com/reference/android/content/Context.html)`

Called when a fragment is first attached to its context.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `@https://developer.android.com/reference/kotlin/androidx/annotation/MainThread
[onAttachFragment](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onAttachFragment(androidx.fragment.app.Fragment))(childFragment: https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment)`

**This function is deprecated.**

The responsibility for listening for fragments being attached has been moved to FragmentManager.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `@https://developer.android.com/reference/kotlin/androidx/annotation/CallSuper
https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onConfigurationChanged(android.content.res.Configuration)(newConfig: https://developer.android.com/reference/android/content/res/Configuration.html)` `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/Fragment#onContextItemSelected(android.view.MenuItem)(item: https://developer.android.com/reference/android/view/MenuItem.html)`

This hook is called whenever an item in a context menu is selected.
`https://developer.android.com/reference/android/view/animation/Animation.html?` `@https://developer.android.com/reference/kotlin/androidx/annotation/MainThread
https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onCreateAnimation(int,boolean,int)(transit: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, enter: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, nextAnim: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`

Called when a fragment loads an animation.
`https://developer.android.com/reference/android/animation/Animator.html?` `@https://developer.android.com/reference/kotlin/androidx/annotation/MainThread
https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onCreateAnimator(int,boolean,int)(transit: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, enter: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, nextAnim: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`

Called when a fragment loads an animator.
`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/Fragment#onCreateContextMenu(android.view.ContextMenu,android.view.View,android.view.ContextMenu.ContextMenuInfo)(
menu: https://developer.android.com/reference/android/view/ContextMenu.html,
v: https://developer.android.com/reference/android/view/View.html,
menuInfo: https://developer.android.com/reference/android/view/ContextMenu.ContextMenuInfo.html?
)`

Called when a context menu for the `view` is about to be shown.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `@https://developer.android.com/reference/kotlin/androidx/annotation/MainThread
[onCreateOptionsMenu](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onCreateOptionsMenu(android.view.Menu,android.view.MenuInflater))(menu: https://developer.android.com/reference/android/view/Menu.html, inflater: https://developer.android.com/reference/android/view/MenuInflater.html)`

**This function is deprecated.**

`https://developer.android.com/reference/kotlin/androidx/activity/ComponentActivity` now implements `https://developer.android.com/reference/kotlin/androidx/core/view/MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `https://developer.android.com/reference/kotlin/androidx/activity/ComponentActivity#addMenuProvider(androidx.core.view.MenuProvider)` without forcing all components through this single method override.

<br />

`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/annotation/CallSuper
https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onDestroy()()`

Called when the fragment is no longer in use.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `@https://developer.android.com/reference/kotlin/androidx/annotation/MainThread
[onDestroyOptionsMenu](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onDestroyOptionsMenu())()`

**This function is deprecated.**

`https://developer.android.com/reference/kotlin/androidx/activity/ComponentActivity` now implements `https://developer.android.com/reference/kotlin/androidx/core/view/MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `https://developer.android.com/reference/kotlin/androidx/core/view/MenuHost#addMenuProvider(androidx.core.view.MenuProvider)` without forcing all components through this single method override.

<br />

`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/annotation/CallSuper
https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onDetach()()`

Called when the fragment is no longer attached to its activity.
`https://developer.android.com/reference/android/view/LayoutInflater.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onGetLayoutInflater(android.os.Bundle)(savedInstanceState: https://developer.android.com/reference/android/os/Bundle.html?)`

Returns the LayoutInflater used to inflate Views of this Fragment.
`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/Fragment#onHiddenChanged(boolean)(hidden: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`

Called when the hidden state (as returned by `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#isHidden()` of the fragment or another fragment in its hierarchy has changed.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `@https://developer.android.com/reference/kotlin/androidx/annotation/UiThread
@https://developer.android.com/reference/kotlin/androidx/annotation/CallSuper
[onInflate](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onInflate(android.app.Activity,android.util.AttributeSet,android.os.Bundle))(
activity: https://developer.android.com/reference/android/app/Activity.html,
attrs: https://developer.android.com/reference/android/util/AttributeSet.html,
savedInstanceState: https://developer.android.com/reference/android/os/Bundle.html?
)`

**This function is deprecated.**

See `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onInflate(android.content.Context,android.util.AttributeSet,android.os.Bundle)`.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `@https://developer.android.com/reference/kotlin/androidx/annotation/UiThread
@https://developer.android.com/reference/kotlin/androidx/annotation/CallSuper
https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onInflate(android.content.Context,android.util.AttributeSet,android.os.Bundle)(
context: https://developer.android.com/reference/android/content/Context.html,
attrs: https://developer.android.com/reference/android/util/AttributeSet.html,
savedInstanceState: https://developer.android.com/reference/android/os/Bundle.html?
)`

Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
`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/annotation/CallSuper
https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onLowMemory()()`

**This function is deprecated.**
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onMultiWindowModeChanged(boolean)(isInMultiWindowMode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`

Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `@https://developer.android.com/reference/kotlin/androidx/annotation/MainThread
[onOptionsItemSelected](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onOptionsItemSelected(android.view.MenuItem))(item: https://developer.android.com/reference/android/view/MenuItem.html)`

**This function is deprecated.**

`https://developer.android.com/reference/kotlin/androidx/activity/ComponentActivity` now implements `https://developer.android.com/reference/kotlin/androidx/core/view/MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `https://developer.android.com/reference/kotlin/androidx/core/view/MenuHost#addMenuProvider(androidx.core.view.MenuProvider)` without forcing all components through this single method override.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `@https://developer.android.com/reference/kotlin/androidx/annotation/MainThread
[onOptionsMenuClosed](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onOptionsMenuClosed(android.view.Menu))(menu: https://developer.android.com/reference/android/view/Menu.html)`

**This function is deprecated.**

`https://developer.android.com/reference/kotlin/androidx/activity/ComponentActivity` now implements `https://developer.android.com/reference/kotlin/androidx/core/view/MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `https://developer.android.com/reference/kotlin/androidx/core/view/MenuHost#addMenuProvider(androidx.core.view.MenuProvider)` without forcing all components through this single method override.

<br />

`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/annotation/CallSuper
https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onPause()()`

Called when the Fragment is no longer resumed.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onPictureInPictureModeChanged(boolean)(isInPictureInPictureMode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`

Called by the system when the activity changes to and from picture-in-picture mode.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `@https://developer.android.com/reference/kotlin/androidx/annotation/MainThread
[onPrepareOptionsMenu](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onPrepareOptionsMenu(android.view.Menu))(menu: https://developer.android.com/reference/android/view/Menu.html)`

**This function is deprecated.**

`https://developer.android.com/reference/kotlin/androidx/activity/ComponentActivity` now implements `https://developer.android.com/reference/kotlin/androidx/core/view/MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `https://developer.android.com/reference/kotlin/androidx/core/view/MenuHost#addMenuProvider(androidx.core.view.MenuProvider)` without forcing all components through this single method override.

<br />

`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/Fragment#onPrimaryNavigationFragmentChanged(boolean)(
isPrimaryNavigationFragment: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html
)`

Callback for when the primary navigation state of this Fragment has changed.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[onRequestPermissionsResult](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onRequestPermissionsResult(int,java.lang.String[],int[]))(
requestCode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html,
permissions: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!>,
grantResults: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int-array/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html>
)`

**This function is deprecated.**

This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContract` and the prebuilt contracts for common intents available in `https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.

<br />

`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/annotation/CallSuper
https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onStart()()`

Called when the Fragment is visible to the user.
`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/annotation/CallSuper
https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onStop()()`

Called when the Fragment is no longer started.
`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/Fragment#onViewCreated(android.view.View,android.os.Bundle)(view: https://developer.android.com/reference/android/view/View.html, savedInstanceState: https://developer.android.com/reference/android/os/Bundle.html?)`

Called immediately after `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)` has returned, but before any saved state has been restored in to the view.
`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/annotation/CallSuper
https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onViewStateRestored(android.os.Bundle)(savedInstanceState: https://developer.android.com/reference/android/os/Bundle.html?)`

Called when all saved state has been restored into the view hierarchy of the fragment.
`https://developer.android.com/reference/android/content/Context.html?` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#peekAvailableContext()()`

Get the `https://developer.android.com/reference/android/content/Context.html` if it is currently available.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#postponeEnterTransition()()`

Postpone the entering Fragment transition until `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#startPostponedEnterTransition()` or `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#executePendingTransactions()` has been called.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#postponeEnterTransition(long,java.util.concurrent.TimeUnit)(duration: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, timeUnit: https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)`

Postpone the entering Fragment transition for a given amount of time and then call `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#startPostponedEnterTransition()`.
`https://developer.android.com/reference/kotlin/androidx/activity/result/ActivityResultLauncher<I!>` `@https://developer.android.com/reference/kotlin/androidx/annotation/MainThread
<I, O> https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#registerForActivityResult(androidx.activity.result.contract.ActivityResultContract<I,O>,androidx.activity.result.ActivityResultCallback<O>)(
contract: https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContract<I!, O!>,
callback: https://developer.android.com/reference/kotlin/androidx/activity/result/ActivityResultCallback<O!>
)`


Register a request to `https://developer.android.com/reference/android/app/Activity.html#startActivityForResult(android.content.Intent, int)`, designated by the given `https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContract`.

<br />

`https://developer.android.com/reference/kotlin/androidx/activity/result/ActivityResultLauncher<I!>` `@https://developer.android.com/reference/kotlin/androidx/annotation/MainThread
<I, O> https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#registerForActivityResult(androidx.activity.result.contract.ActivityResultContract<I,O>,androidx.activity.result.ActivityResultRegistry,androidx.activity.result.ActivityResultCallback<O>)(
contract: https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContract<I!, O!>,
registry: https://developer.android.com/reference/kotlin/androidx/activity/result/ActivityResultRegistry,
callback: https://developer.android.com/reference/kotlin/androidx/activity/result/ActivityResultCallback<O!>
)`

Register a request to `https://developer.android.com/reference/android/app/Activity.html#startActivityForResult(android.content.Intent, int)`, designated by the given `https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContract`.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#registerForContextMenu(android.view.View)(view: https://developer.android.com/reference/android/view/View.html)`

Registers a context menu to be shown for the given view (multiple views can show the context menu).
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#removeOnContextAvailableListener(androidx.activity.contextaware.OnContextAvailableListener)(listener: https://developer.android.com/reference/kotlin/androidx/activity/contextaware/OnContextAvailableListener)`

Remove a `https://developer.android.com/reference/kotlin/androidx/activity/contextaware/OnContextAvailableListener` previously added via `https://developer.android.com/reference/kotlin/androidx/activity/contextaware/ContextAware#addOnContextAvailableListener(androidx.activity.contextaware.OnContextAvailableListener)`.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[requestPermissions](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#requestPermissions(java.lang.String[],int))(permissions: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!>, requestCode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`

**This function is deprecated.**

This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContract` and the prebuilt contracts for common intents available in `https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.

<br />

`https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentActivity` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#requireActivity()()`

Return the `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentActivity` this fragment is currently associated with.
`https://developer.android.com/reference/android/os/Bundle.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#requireArguments()()`

Return the arguments supplied when the fragment was instantiated.
`https://developer.android.com/reference/android/content/Context.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#requireContext()()`

Return the `https://developer.android.com/reference/android/content/Context.html` this fragment is currently associated with.
`https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager` `[requireFragmentManager](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#requireFragmentManager())()`

**This function is deprecated.**

This has been renamed to `getParentFragmentManager()` to make it clear that you are accessing the FragmentManager that contains this Fragment and not the FragmentManager associated with child Fragments.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#requireHost()()`

Return the host object of this fragment.
`https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#requireParentFragment()()`

Returns the parent Fragment containing this Fragment.
`https://developer.android.com/reference/android/view/View.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#requireView()()`

Get the root view for the fragment's layout (the one returned by `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)`).
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setAllowEnterTransitionOverlap(boolean)(allow: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`

Sets whether the the exit transition and enter transition overlap or not.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setAllowReturnTransitionOverlap(boolean)(allow: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`

Sets whether the the return transition and reenter transition overlap or not.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setArguments(android.os.Bundle)(args: https://developer.android.com/reference/android/os/Bundle.html?)`

Supply the construction arguments for this fragment.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setEnterSharedElementCallback(androidx.core.app.SharedElementCallback)(callback: https://developer.android.com/reference/kotlin/androidx/core/app/SharedElementCallback?)`

When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setEnterTransition(java.lang.Object)(transition: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)`

Sets the Transition that will be used to move Views into the initial scene.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setExitSharedElementCallback(androidx.core.app.SharedElementCallback)(callback: https://developer.android.com/reference/kotlin/androidx/core/app/SharedElementCallback?)`

When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setExitTransition(java.lang.Object)(transition: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)`

Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[setHasOptionsMenu](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setHasOptionsMenu(boolean))(hasMenu: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`

**This function is deprecated.**

This method is no longer needed when using a `https://developer.android.com/reference/kotlin/androidx/core/view/MenuProvider` to provide a `https://developer.android.com/reference/android/view/Menu.html` to your activity, which replaces `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#onCreateOptionsMenu(android.view.Menu,android.view.MenuInflater)` as the recommended way to provide a consistent, optionally `https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle`-aware, and modular way to handle menu creation and item selection.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setInitialSavedState(androidx.fragment.app.Fragment.SavedState)(state: https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment.SavedState?)`

Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#saveFragmentInstanceState(androidx.fragment.app.Fragment)`.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setMenuVisibility(boolean)(menuVisible: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`

Set a hint for whether this fragment's menu should be visible.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setReenterTransition(java.lang.Object)(transition: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)`

Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[setRetainInstance](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setRetainInstance(boolean))(retain: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`

**This function is deprecated.**

Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setReturnTransition(java.lang.Object)(transition: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)`

Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setSharedElementEnterTransition(java.lang.Object)(transition: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)`

Sets the Transition that will be used for shared elements transferred into the content Scene.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setSharedElementReturnTransition(java.lang.Object)(transition: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)`

Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[setTargetFragment](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setTargetFragment(androidx.fragment.app.Fragment,int))(fragment: https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment?, requestCode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`

**This function is deprecated.**

Instead of using a target fragment to pass results, the fragment requesting a result should use `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#setFragmentResultListener(java.lang.String,androidx.lifecycle.LifecycleOwner,androidx.fragment.app.FragmentResultListener)` to register a `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentResultListener` with a `
requestKey` using its `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#getParentFragmentManager()`.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[setUserVisibleHint](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setUserVisibleHint(boolean))(isVisibleToUser: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`

**This function is deprecated.**

If you are manually calling this method, use `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#setMaxLifecycle(androidx.fragment.app.Fragment,androidx.lifecycle.Lifecycle.State)` instead.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#shouldShowRequestPermissionRationale(java.lang.String)(permission: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`

Gets whether you should show UI with rationale before requesting a permission.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#startActivity(android.content.Intent)(intent: https://developer.android.com/reference/android/content/Intent.html)`

Call `https://developer.android.com/reference/android/app/Activity.html#startActivity(android.content.Intent)` from the fragment's containing Activity.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#startActivity(android.content.Intent,android.os.Bundle)(intent: https://developer.android.com/reference/android/content/Intent.html, options: https://developer.android.com/reference/android/os/Bundle.html?)`

Call `https://developer.android.com/reference/android/app/Activity.html#startActivity(android.content.Intent, android.os.Bundle)` from the fragment's containing Activity.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[startActivityForResult](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#startActivityForResult(android.content.Intent,int))(intent: https://developer.android.com/reference/android/content/Intent.html, requestCode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`

**This function is deprecated.**

This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContract` and the prebuilt contracts for common intents available in `https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[startActivityForResult](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#startActivityForResult(android.content.Intent,int,android.os.Bundle))(intent: https://developer.android.com/reference/android/content/Intent.html, requestCode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, options: https://developer.android.com/reference/android/os/Bundle.html?)`

**This function is deprecated.**

This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContract` and the prebuilt contracts for common intents available in `https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[startIntentSenderForResult](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#startIntentSenderForResult(android.content.IntentSender,int,android.content.Intent,int,int,int,android.os.Bundle))(
intent: https://developer.android.com/reference/android/content/IntentSender.html,
requestCode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html,
fillInIntent: https://developer.android.com/reference/android/content/Intent.html?,
flagsMask: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html,
flagsValues: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html,
extraFlags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html,
options: https://developer.android.com/reference/android/os/Bundle.html?
)`

**This function is deprecated.**

This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContract` and the prebuilt contracts for common intents available in `https://developer.android.com/reference/kotlin/androidx/activity/result/contract/ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#startPostponedEnterTransition()()`

Begin postponed transitions after `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#postponeEnterTransition()` was called.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#toString()()` `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#unregisterForContextMenu(android.view.View)(view: https://developer.android.com/reference/android/view/View.html)`

Prevents a context menu to be shown for the given view.
From [androidx.lifecycle.HasDefaultViewModelProviderFactory](https://developer.android.com/reference/kotlin/androidx/lifecycle/HasDefaultViewModelProviderFactory) `https://developer.android.com/reference/kotlin/androidx/lifecycle/viewmodel/CreationExtras!` `https://developer.android.com/reference/kotlin/androidx/lifecycle/HasDefaultViewModelProviderFactory#getDefaultViewModelCreationExtras()()`

The default `https://developer.android.com/reference/kotlin/androidx/lifecycle/viewmodel/CreationExtras` to pass into `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory#create(kotlin.reflect.KClass,androidx.lifecycle.viewmodel.CreationExtras)` when no overriding `https://developer.android.com/reference/kotlin/androidx/lifecycle/viewmodel/CreationExtras` are provided.
`https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory!` `https://developer.android.com/reference/kotlin/androidx/lifecycle/HasDefaultViewModelProviderFactory#getDefaultViewModelProviderFactory()()`

The default `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory` to use when no custom `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory` is provided to the `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider`.
From [androidx.lifecycle.LifecycleOwner](https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner) `abstract https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle!` `https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner#getLifecycle()()`

The `https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle` of this owner.
From [androidx.savedstate.SavedStateRegistryOwner](https://developer.android.com/reference/kotlin/androidx/savedstate/SavedStateRegistryOwner) `abstract https://developer.android.com/reference/kotlin/androidx/savedstate/SavedStateRegistry!` `https://developer.android.com/reference/kotlin/androidx/savedstate/SavedStateRegistryOwner#getSavedStateRegistry()()`

The `https://developer.android.com/reference/kotlin/androidx/savedstate/SavedStateRegistry` owned by this `https://developer.android.com/reference/kotlin/androidx/savedstate/SavedStateRegistryOwner`.
From [android.view.View.OnCreateContextMenuListener](https://developer.android.com/reference/android/view/View.OnCreateContextMenuListener.html) `abstract https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/android/view/View.OnCreateContextMenuListener.html#onCreateContextMenu(android.view.ContextMenu, android.view.View, android.view.ContextMenu.ContextMenuInfo)(
p: https://developer.android.com/reference/android/view/ContextMenu.html!,
p1: https://developer.android.com/reference/android/view/View.html!,
p2: https://developer.android.com/reference/android/view/ContextMenu.ContextMenuInfo.html!
)` From [androidx.lifecycle.ViewModelStoreOwner](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelStoreOwner) `abstract https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelStore!` `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelStoreOwner#getViewModelStore()()`

The owned `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelStore`

## Constants

### EXTRA_UI_STYLE

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
const val EXTRA_UI_STYLE = "uiStyle": String!
```

Fragment argument name for UI style. The argument value is persisted in fragment state and used to select fragment transition. The value is initially `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ENTRANCE()` and might be changed in one of the three helper functions:

- `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#addAsRoot(androidx.fragment.app.FragmentActivity,androidx.leanback.app.GuidedStepSupportFragment,int)` sets to `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ACTIVITY_ROOT()`
- `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#add(androidx.fragment.app.FragmentManager,androidx.leanback.app.GuidedStepSupportFragment)` or `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#add(androidx.fragment.app.FragmentManager,androidx.leanback.app.GuidedStepSupportFragment,int)` sets it to `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_REPLACE()` if there is already a GuidedStepSupportFragment on stack.
- `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#finishGuidedStepSupportFragments()` changes current GuidedStepSupportFragment to `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ENTRANCE()` for the non activity case. This is a special case that changes the transition settings after fragment has been created, in order to force current GuidedStepSupportFragment run a return transition of `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ENTRANCE()`

Argument value can be either:

- `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_REPLACE()`
- `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ENTRANCE()`
- `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ACTIVITY_ROOT()`

### UI_STYLE_ACTIVITY_ROOT

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
const val UI_STYLE_ACTIVITY_ROOT = 2: Int
```

One possible value of argument `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#EXTRA_UI_STYLE()`. This is the case that we show first GuidedStepSupportFragment in a separate activity. The default behavior of this style:

- Enter transition is assigned null (will rely on activity transition), exit transition is same as `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ENTRANCE()`. Note: Changing exit transition by UI style is not working because fragment transition asks for exit transition before UI style is restored in Fragment.onCreate().

### UI_STYLE_DEFAULT

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
const val UI_STYLE_DEFAULT = 0: Int
```

> [!CAUTION]
> **This property is deprecated.**   
>
> Same value as `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_REPLACE()`.

### UI_STYLE_ENTRANCE

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
const val UI_STYLE_ENTRANCE = 1: Int
```

Default value for argument `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#EXTRA_UI_STYLE()`. The default value is assigned in GuidedStepSupportFragment constructor. This is the case that we show GuidedStepSupportFragment on top of other content. The default behavior of this style:

- Enter transition slides in from two sides, exit transition slide out to START(left). Background will be faded in. Note: Changing exit transition by UI style is not working because fragment transition asks for exit transition before UI style is restored in Fragment .onCreate().

When popping multiple GuidedStepSupportFragment, `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#finishGuidedStepSupportFragments()` also changes the top GuidedStepSupportFragment to UI_STYLE_ENTRANCE in order to run the return transition (reverse of enter transition) of UI_STYLE_ENTRANCE.

### UI_STYLE_REPLACE

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
const val UI_STYLE_REPLACE = 0: Int
```

This is the case that we use GuidedStepSupportFragment to replace another existing GuidedStepSupportFragment when moving forward to next step. Default behavior of this style is:

- Enter transition slides in from END(right), exit transition same as `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ENTRANCE()`.

## Public constructors

### GuidedStepSupportFragment

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
GuidedStepSupportFragment()
```

## Public functions

### add

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
java-static fun add(
    fragmentManager: FragmentManager,
    fragment: GuidedStepSupportFragment
): Int
```

Adds the specified GuidedStepSupportFragment to the fragment stack, replacing any existing GuidedStepSupportFragments in the stack, and configuring the fragment-to-fragment custom transitions. A backstack entry is added, so the fragment will be dismissed when BACK key is pressed.

- If current fragment on stack is GuidedStepSupportFragment: assign `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_REPLACE()`
- If current fragment on stack is not GuidedStepSupportFragment: assign `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ENTRANCE()`

Note: currently fragments added using this method must be created programmatically rather than via XML.

| Parameters |
|---|---|
| `fragmentManager: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager` | The FragmentManager to be used in the transaction. |
| `fragment: https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment` | The GuidedStepSupportFragment to be inserted into the fragment stack. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The ID returned by the call FragmentTransaction.commit. |

### add

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
java-static fun add(
    fragmentManager: FragmentManager,
    fragment: GuidedStepSupportFragment,
    id: Int
): Int
```

Adds the specified GuidedStepSupportFragment to the fragment stack, replacing any existing GuidedStepSupportFragments in the stack, and configuring the fragment-to-fragment custom transitions. A backstack entry is added, so the fragment will be dismissed when BACK key is pressed.

- If current fragment on stack is GuidedStepSupportFragment: assign `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_REPLACE()` and `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onAddSharedElementTransition(androidx.fragment.app.FragmentTransaction,androidx.leanback.app.GuidedStepSupportFragment)` will be called to perform shared element transition between GuidedStepSupportFragments.
- If current fragment on stack is not GuidedStepSupportFragment: assign `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ENTRANCE()`

Note: currently fragments added using this method must be created programmatically rather than via XML.

| Parameters |
|---|---|
| `fragmentManager: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager` | The FragmentManager to be used in the transaction. |
| `fragment: https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment` | The GuidedStepSupportFragment to be inserted into the fragment stack. |
| `id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The id of container to add GuidedStepSupportFragment, can be android.R.id.content. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The ID returned by the call FragmentTransaction.commit. |

### addAsRoot

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
java-static fun addAsRoot(
    activity: FragmentActivity,
    fragment: GuidedStepSupportFragment,
    id: Int
): Int
```

Adds the specified GuidedStepSupportFragment as content of Activity; no backstack entry is added so the activity will be dismissed when BACK key is pressed. The method is typically called in Activity.onCreate() when savedInstanceState is null. When savedInstanceState is not null, the Activity is being restored, do not call addAsRoot() to duplicate the Fragment restored by FragmentManager. `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ACTIVITY_ROOT()` is assigned. Note: currently fragments added using this method must be created programmatically rather than via XML.

| Parameters |
|---|---|
| `activity: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentActivity` | The Activity to be used to insert GuidedstepFragment. |
| `fragment: https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment` | The GuidedStepSupportFragment to be inserted into the fragment stack. |
| `id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The id of container to add GuidedStepSupportFragment, can be android.R.id.content. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The ID returned by the call FragmentTransaction.commit, or -1 there is already GuidedStepSupportFragment. |

### collapseAction

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun collapseAction(withTransition: Boolean): Unit
```

Collapse action which either has a sub actions list or action with `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction#hasEditableActivatorView()` is true.

| Parameters |
|---|---|
| `withTransition: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | True to run transition animation, false otherwise. |

### collapseSubActions

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun collapseSubActions(): Unit
```

Collapse sub actions list.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction#getSubActions()` |   |

### expandAction

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun expandAction(action: GuidedAction, withTransition: Boolean): Unit
```

Expand a given action with sub actions list or `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction#hasEditableActivatorView()` is true. The method must be called after `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)` creates fragment view.

| Parameters |
|---|---|
| `action: https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction` | GuidedAction to expand. |
| `withTransition: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | True to run transition animation, false otherwise. |

### expandSubActions

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun expandSubActions(action: GuidedAction): Unit
```

Expand a given action's sub actions list.

| Parameters |
|---|---|
| `action: https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction` | GuidedAction to expand. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#expandAction(androidx.leanback.widget.GuidedAction,boolean)` |   |

### findActionById

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun findActionById(id: Long): GuidedAction?
```

Find GuidedAction by Id.

| Parameters |
|---|---|
| `id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | Id of the action to search. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction?` | GuidedAction object or null if not found. |

### findActionPositionById

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun findActionPositionById(id: Long): Int
```

Find GuidedAction position in array by Id.

| Parameters |
|---|---|
| `id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | Id of the action to search. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | position of GuidedAction object in array or -1 if not found. |

### findButtonActionById

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun findButtonActionById(id: Long): GuidedAction?
```

Find button GuidedAction by Id.

| Parameters |
|---|---|
| `id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | Id of the button action to search. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction?` | GuidedAction object or null if not found. |

### findButtonActionPositionById

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun findButtonActionPositionById(id: Long): Int
```

Find button GuidedAction position in array by Id.

| Parameters |
|---|---|
| `id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | Id of the button action to search. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | position of GuidedAction object in array or -1 if not found. |

### finishGuidedStepSupportFragments

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun finishGuidedStepSupportFragments(): Unit
```

Convenient method to close GuidedStepSupportFragments on top of other content or finish Activity if GuidedStepSupportFragments were started in a separate activity. Pops all stack entries including `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ENTRANCE()`; if `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ENTRANCE()` is not found, finish the activity. Note that this method must be paired with `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#add(androidx.fragment.app.FragmentManager,androidx.leanback.app.GuidedStepSupportFragment,int)` which sets up the stack entry name for finding which fragment we need to pop back to.

### getActionItemView

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun getActionItemView(position: Int): View?
```

Returns the view corresponding to the action at the indicated position in the list of actions for this fragment.

| Parameters |
|---|---|
| `position: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The integer position of the action of interest. |

| Returns |
|---|---|
| `https://developer.android.com/reference/android/view/View.html?` | The View corresponding to the action at the indicated position, or null if that action is not currently onscreen. |

### getActions

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun getActions(): (Mutable)List<GuidedAction!>
```

Returns the list of GuidedActions that the user may take in this fragment.

| 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<https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction!>` | The list of GuidedActions for this fragment. |

### getButtonActionItemView

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun getButtonActionItemView(position: Int): View?
```

Returns the view corresponding to the button action at the indicated position in the list of actions for this fragment.

| Parameters |
|---|---|
| `position: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The integer position of the button action of interest. |

| Returns |
|---|---|
| `https://developer.android.com/reference/android/view/View.html?` | The View corresponding to the button action at the indicated position, or null if that action is not currently onscreen. |

### getButtonActions

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun getButtonActions(): (Mutable)List<GuidedAction!>
```

Returns the list of button GuidedActions that the user may take in this fragment.

| 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<https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction!>` | The list of button GuidedActions for this fragment. |

### getCurrentGuidedStepSupportFragment

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
java-static fun getCurrentGuidedStepSupportFragment(fm: FragmentManager): GuidedStepSupportFragment?
```

Returns the current GuidedStepSupportFragment on the fragment transaction stack.

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment?` | The current GuidedStepSupportFragment, if any, on the fragment transaction stack. |

### getGuidanceStylist

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun getGuidanceStylist(): GuidanceStylist
```

Returns the GuidanceStylist that displays guidance information for the user.

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidanceStylist` | The GuidanceStylist for this fragment. |

### getGuidedActionsStylist

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun getGuidedActionsStylist(): GuidedActionsStylist
```

Returns the GuidedActionsStylist that displays the actions the user may take.

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionsStylist` | The GuidedActionsStylist for this fragment. |

### getGuidedButtonActionsStylist

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun getGuidedButtonActionsStylist(): GuidedActionsStylist
```

Returns the GuidedActionsStylist that displays the button actions the user may take.

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionsStylist` | The GuidedActionsStylist for this fragment. |

### getSelectedActionPosition

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun getSelectedActionPosition(): Int
```

Returns the position if the currently selected GuidedAction.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | position The integer position of the currently selected action. |

### getSelectedButtonActionPosition

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun getSelectedButtonActionPosition(): Int
```

Returns the position if the currently selected button GuidedAction.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | position The integer position of the currently selected button action. |

### getUiStyle

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun getUiStyle(): Int
```

Read UI style from fragment arguments. Default value is `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ENTRANCE()` when fragment is first initialized. UI style is used to choose different fragment transition animations and determine if this is the first GuidedStepSupportFragment on backstack.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ACTIVITY_ROOT()``https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_REPLACE()` or `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ENTRANCE()`. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onProvideFragmentTransitions()` |   |

### isExpanded

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun isExpanded(): Boolean
```

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | True if is current expanded including subactions list or action with `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction#hasEditableActivatorView()` is true. |

### isFocusOutEndAllowed

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun isFocusOutEndAllowed(): Boolean
```

Returns true if allows focus out of end edge of GuidedStepSupportFragment, false otherwise. Default value is false, the reason is to disable FocusFinder to find focusable views beneath content of GuidedStepSupportFragment. Subclass may override.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | True if allows focus out of end edge of GuidedStepSupportFragment. |

### isFocusOutStartAllowed

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun isFocusOutStartAllowed(): Boolean
```

Returns true if allows focus out of start edge of GuidedStepSupportFragment, false otherwise. Default value is false, the reason is to disable FocusFinder to find focusable views beneath content of GuidedStepSupportFragment. Subclass may override.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | True if allows focus out of start edge of GuidedStepSupportFragment. |

### isSubActionsExpanded

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun isSubActionsExpanded(): Boolean
```

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | True if the sub actions list is expanded, false otherwise. |

### notifyActionChanged

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun notifyActionChanged(position: Int): Unit
```

Notify an action has changed and update its UI.

| Parameters |
|---|---|
| `position: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | Position of the GuidedAction in array. |

### notifyButtonActionChanged

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun notifyButtonActionChanged(position: Int): Unit
```

Notify an button action has changed and update its UI.

| Parameters |
|---|---|
| `position: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | Position of the button GuidedAction in array. |

### onCreate

```
fun onCreate(savedInstanceState: Bundle?): Unit
```

Called to do initial creation of a fragment. This is called after #onAttach(Activity) and before #onCreateView(LayoutInflater, ViewGroup, Bundle).

Note that this can be called while the fragment's activity is still in the process of being created. As such, you can not rely on things like the activity's content view hierarchy being initialized at this point. If you want to do work once the activity itself is created, add a on the activity's Lifecycle, removing it when it receives the Lifecycle.State#CREATED callback.

Any restored child fragments will be created before the base `Fragment.onCreate` method returns.

### onCreateActions

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun onCreateActions(
    actions: (Mutable)List<GuidedAction!>,
    savedInstanceState: Bundle?
): Unit
```

Fills out the set of actions available to the user. This hook is called during `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreate(android.os.Bundle)`. The default leaves the list of actions empty; subclasses should override.

| Parameters |
|---|---|
| `actions: (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/leanback/widget/GuidedAction!>` | A non-null, empty list ready to be populated. |
| `savedInstanceState: https://developer.android.com/reference/android/os/Bundle.html?` | The saved instance state from onCreate. |

### onCreateActionsStylist

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun onCreateActionsStylist(): GuidedActionsStylist
```

Creates the presenter used to style the guided actions panel. The default implementation returns a basic GuidedActionsStylist.

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionsStylist` | The GuidedActionsStylist used in this fragment. |

### onCreateBackgroundView

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun onCreateBackgroundView(
    inflater: LayoutInflater,
    container: ViewGroup?,
    savedInstanceState: Bundle?
): View?
```

Called by onCreateView to inflate background view. Default implementation loads view from which holds a reference to guidedStepBackground.

| Parameters |
|---|---|
| `inflater: https://developer.android.com/reference/android/view/LayoutInflater.html` | LayoutInflater to load background view. |
| `container: https://developer.android.com/reference/android/view/ViewGroup.html?` | Parent view of background view. |
| `savedInstanceState: https://developer.android.com/reference/android/os/Bundle.html?` |   |

| Returns |
|---|---|
| `https://developer.android.com/reference/android/view/View.html?` | Created background view or null if no background. |

### onCreateButtonActions

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun onCreateButtonActions(
    actions: (Mutable)List<GuidedAction!>,
    savedInstanceState: Bundle?
): Unit
```

Fills out the set of actions shown at right available to the user. This hook is called during `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreate(android.os.Bundle)`. The default leaves the list of actions empty; subclasses may override.

| Parameters |
|---|---|
| `actions: (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/leanback/widget/GuidedAction!>` | A non-null, empty list ready to be populated. |
| `savedInstanceState: https://developer.android.com/reference/android/os/Bundle.html?` | The saved instance state from onCreate. |

### onCreateButtonActionsStylist

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun onCreateButtonActionsStylist(): GuidedActionsStylist
```

Creates the presenter used to style a sided actions panel for button only. The default implementation returns a basic GuidedActionsStylist.

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionsStylist` | The GuidedActionsStylist used in this fragment. |

### onCreateGuidance

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun onCreateGuidance(savedInstanceState: Bundle?): GuidanceStylist.Guidance
```

Returns the information required to provide guidance to the user. This hook is called during `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)`. May be overridden to return a custom subclass of `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidanceStylist.Guidance` for use in a subclass of `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidanceStylist`. The default returns a Guidance object with empty fields; subclasses should override.

| Parameters |
|---|---|
| `savedInstanceState: https://developer.android.com/reference/android/os/Bundle.html?` | The saved instance state from onCreateView. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidanceStylist.Guidance` | The Guidance object representing the information used to guide the user. |

### onCreateGuidanceStylist

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun onCreateGuidanceStylist(): GuidanceStylist
```

Creates the presenter used to style the guidance panel. The default implementation returns a basic GuidanceStylist.

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidanceStylist` | The GuidanceStylist used in this fragment. |

### onCreateView

```
fun onCreateView(
    inflater: LayoutInflater,
    container: ViewGroup?,
    savedInstanceState: Bundle?
): View?
```

Called to have the fragment instantiate its user interface view. This is optional, and non-graphical fragments can return null. This will be called between #onCreate(Bundle) and #onViewCreated(View, Bundle).

A default View can be returned by calling #Fragment(int) in your constructor. Otherwise, this method returns null.

It is recommended to **only** inflate the layout in this method and move logic that operates on the returned View to #onViewCreated(View, Bundle).

If you return a View from here, you will later be called in #onDestroyView when the view is being released.

### onDestroyView

```
fun onDestroyView(): Unit
```

Called when the view previously created by #onCreateView has been detached from the fragment. The next time the fragment needs to be displayed, a new view will be created. This is called after #onStop() and before #onDestroy(). It is called *regardless* of whether #onCreateView returned a non-null view. Internally it is called after the view's state has been saved but before it has been removed from its parent.

### onGuidedActionClicked

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun onGuidedActionClicked(action: GuidedAction): Unit
```

Callback invoked when an action is taken by the user. Subclasses should override in order to act on the user's decisions.

| Parameters |
|---|---|
| `action: https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction` | The chosen action. |

### onGuidedActionEditCanceled

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun onGuidedActionEditCanceled(action: GuidedAction): Unit
```

Callback invoked when an action has been canceled editing, for example when user closes IME window by BACK key. Default implementation calls deprecated method `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onGuidedActionEdited(androidx.leanback.widget.GuidedAction)`.

| Parameters |
|---|---|
| `action: https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction` | The action which has been canceled editing. |

### onGuidedActionEdited

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun [onGuidedActionEdited](https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onGuidedActionEdited(androidx.leanback.widget.GuidedAction))(action: GuidedAction!): Unit
```

> [!CAUTION]
> **This function is deprecated.**   
>
> Override `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onGuidedActionEditedAndProceed(androidx.leanback.widget.GuidedAction)` and/or `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onGuidedActionEditCanceled(androidx.leanback.widget.GuidedAction)`.

Callback invoked when an action's title or description has been edited, this happens either when user clicks confirm button in IME or user closes IME window by BACK key.

### onGuidedActionEditedAndProceed

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun onGuidedActionEditedAndProceed(action: GuidedAction): Long
```

Callback invoked when an action has been edited, for example when user clicks confirm button in IME window. Default implementation calls deprecated method `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onGuidedActionEdited(androidx.leanback.widget.GuidedAction)` and returns `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction#ACTION_ID_NEXT()`.

| Parameters |
|---|---|
| `action: https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction` | The action that has been edited. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | ID of the action will be focused or `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction#ACTION_ID_NEXT()`, `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction#ACTION_ID_CURRENT()`. |

### onGuidedActionFocused

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun onGuidedActionFocused(action: GuidedAction): Unit
```

Callback invoked when an action is focused (made to be the current selection) by the user.

### onProvideTheme

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun onProvideTheme(): Int
```

Returns the theme used for styling the fragment. The default returns -1, indicating that the host Activity's theme should be used.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The theme resource ID of the theme to use in this fragment, or -1 to use the host Activity's theme. |

### onResume

```
fun onResume(): Unit
```

Called when the fragment is visible to the user and actively running. This is generally tied to `https://developer.android.com/reference/android/app/Activity.html#onResume()` of the containing Activity's lifecycle.

### onSaveInstanceState

```
fun onSaveInstanceState(outState: Bundle): Unit
```

Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance if its process is restarted. If a new instance of the fragment later needs to be created, the data you place in the Bundle here will be available in the Bundle given to #onCreate(Bundle), #onCreateView(LayoutInflater, ViewGroup, Bundle), and #onViewCreated(View, Bundle).

This corresponds to Activity#onSaveInstanceState(Bundle) Activity.onSaveInstanceState(Bundle) and most of the discussion there applies here as well. Note however: *this method may be called at any time before #onDestroy()*. There are many situations where a fragment may be mostly torn down (such as when placed on the back stack with no UI showing), but its state will not be saved until its owning activity actually needs to save its state.

### onSubGuidedActionClicked

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun onSubGuidedActionClicked(action: GuidedAction): Boolean
```

Callback invoked when an action in sub actions is taken by the user. Subclasses should override in order to act on the user's decisions. Default return value is true to close the sub actions list.

| Parameters |
|---|---|
| `action: https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction` | The chosen action. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | true to collapse the sub actions list, false to keep it expanded. |

### openInEditMode

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun openInEditMode(action: GuidedAction?): Unit
```

Opens the provided action in edit mode and raises ime. This can be used to programmatically skip the extra click required to go into edit mode. This method can be invoked in `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)`.

### popBackStackToGuidedStepSupportFragment

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun popBackStackToGuidedStepSupportFragment(
    guidedStepFragmentClass: Class<*>,
    flags: Int
): Unit
```

Convenient method to pop to fragment with Given class.

| Parameters |
|---|---|
| `guidedStepFragmentClass: https://developer.android.com/reference/java/lang/Class.html<*>` | Name of the Class of GuidedStepSupportFragment to pop to. |
| `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()`. |

### setActions

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun setActions(actions: (Mutable)List<GuidedAction!>): Unit
```

Sets the list of GuidedActions that the user may take in this fragment. Uses DiffCallback set by `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#setActionsDiffCallback(androidx.leanback.widget.DiffCallback<androidx.leanback.widget.GuidedAction>)`.

| Parameters |
|---|---|
| `actions: (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/leanback/widget/GuidedAction!>` | The list of GuidedActions for this fragment. |

### setActionsDiffCallback

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun setActionsDiffCallback(diffCallback: DiffCallback<GuidedAction!>?): Unit
```

Sets the RecyclerView DiffCallback used when `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#setActions(java.util.List<androidx.leanback.widget.GuidedAction>)` is called. By default GuidedStepSupportFragment uses `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionDiffCallback`. Sets it to null if app wants to refresh the whole list.

| Parameters |
|---|---|
| `diffCallback: https://developer.android.com/reference/kotlin/androidx/leanback/widget/DiffCallback<https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedAction!>?` | DiffCallback used in `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#setActions(java.util.List<androidx.leanback.widget.GuidedAction>)`. |

### setButtonActions

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun setButtonActions(actions: (Mutable)List<GuidedAction!>): Unit
```

Sets the list of button GuidedActions that the user may take in this fragment.

| Parameters |
|---|---|
| `actions: (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/leanback/widget/GuidedAction!>` | The list of button GuidedActions for this fragment. |

### setSelectedActionPosition

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun setSelectedActionPosition(position: Int): Unit
```

Scrolls the action list to the position indicated, selecting that action's view.

| Parameters |
|---|---|
| `position: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The integer position of the action of interest. |

### setSelectedButtonActionPosition

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun setSelectedButtonActionPosition(position: Int): Unit
```

Scrolls the action list to the position indicated, selecting that button action's view.

| Parameters |
|---|---|
| `position: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The integer position of the button action of interest. |

### setUiStyle

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
fun setUiStyle(style: Int): Unit
```

Set UI style to fragment arguments. Default value is `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ENTRANCE()` when fragment is first initialized. UI style is used to choose different fragment transition animations and determine if this is the first GuidedStepSupportFragment on backstack. In most cases app does not directly call this method, app calls helper function `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#add(androidx.fragment.app.FragmentManager,androidx.leanback.app.GuidedStepSupportFragment,int)`. However if the app creates Fragment transaction and controls backstack by itself, it would need call setUiStyle() to select the fragment transition to use.

| Parameters |
|---|---|
| `style: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ACTIVITY_ROOT()``https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_REPLACE()` or `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ENTRANCE()`. |

## Protected functions

### onAddSharedElementTransition

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
protected fun onAddSharedElementTransition(
    ft: FragmentTransaction,
    disappearing: GuidedStepSupportFragment
): Unit
```

Called when this fragment is added to FragmentTransaction with `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_REPLACE()` (aka when the GuidedStepSupportFragment replacing an existing GuidedStepSupportFragment). Default implementation establishes connections between action background views to morph action background bounds change from disappearing GuidedStepSupportFragment into this GuidedStepSupportFragment. The default implementation heavily relies on `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionsStylist`'s layout, app may override this method when modifying the default layout of `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionsStylist`.

| Parameters |
|---|---|
| `ft: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction` | The FragmentTransaction to add shared element. |
| `disappearing: https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment` | The disappearing fragment. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionsStylist` |   |
| `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#onProvideFragmentTransitions()` |   |

### onProvideFragmentTransitions

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
protected fun onProvideFragmentTransitions(): Unit
```

Called by Constructor to provide fragment transitions. The default implementation assigns transitions based on `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#getUiStyle()`:

- `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_REPLACE()` Slide from/to end(right) for enter transition, slide from/to start(left) for exit transition, shared element enter transition is set to ChangeBounds.
- `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ENTRANCE()` Enter transition is set to slide from both sides, exit transition is same as `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_REPLACE()`, no shared element enter transition.
- `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_ACTIVITY_ROOT()` Enter transition is set to null and app should rely on activity transition, exit transition is same as `https://developer.android.com/reference/kotlin/androidx/leanback/app/GuidedStepSupportFragment#UI_STYLE_REPLACE()`, no shared element enter transition.

The default implementation heavily relies on `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionsStylist` and `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidanceStylist` layout, app may override this method when modifying the default layout of `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidedActionsStylist` or `https://developer.android.com/reference/kotlin/androidx/leanback/widget/GuidanceStylist`.

TIP: because the fragment view is removed during fragment transition, in general app cannot use two Visibility transition together. Workaround is to create your own Visibility transition that controls multiple animators (e.g. slide and fade animation in one Transition class).