AbstractProgressFragment

public abstract class AbstractProgressFragment extends Fragment

java.lang.Object
   ↳ androidx.fragment.app.Fragment
     ↳ androidx.navigation.dynamicfeatures.fragment.ui.AbstractProgressFragment
Known direct subclasses
DefaultProgressFragment

The default androidx.fragment.app.Fragment to display during installation progress.

The base class for Fragments that handle dynamic feature installation.

When extending from this class, you are responsible for forwarding installation state changes to your UI via the provided hooks in onCancelled, onFailed, onProgress.

The installation process itself is handled within the AbstractProgressFragment itself. Navigation to the target destination will occur once the installation is completed.

Summary

Public constructors
AbstractProgressFragment(int contentLayoutId)

Public methods
void
onCreate(Bundle savedInstanceState)

Called to do initial creation of a fragment.
void

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.
void
onViewCreated(@NonNull View view, Bundle savedInstanceState)

Called immediately after onCreateView has returned, but before any saved state has been restored in to the view.

Protected methods
abstract void

Called when the user decided to cancel installation.
abstract void

Called when the installation has failed due to non-user issues.
void

Called when requested module has been successfully installed, just before the NavController navigates to the final destination.
abstract void
onProgress(
    @SplitInstallSessionStatus int status,
    long bytesDownloaded,
    long bytesTotal
)

Called when there was a progress update for an active module download.

Inherited methods
From androidx.activity.result.ActivityResultCaller
final @NonNull ActivityResultLauncher<@NonNull I>
@MainThread
<I extends Object, O extends Object> registerForActivityResult(
    @NonNull ActivityResultContract<@NonNull I, @NonNull O> contract,
    @NonNull ActivityResultCallback<@NonNull O> callback
)

Register a request to start an activity for result, designated by the given contract.
final @NonNull ActivityResultLauncher<@NonNull I>
@MainThread
<I extends Object, O extends Object> registerForActivityResult(
    @NonNull ActivityResultContract<@NonNull I, @NonNull O> contract,
    @NonNull ActivityResultRegistry registry,
    @NonNull ActivityResultCallback<@NonNull O> callback
)

Register a request to start an activity for result, designated by the given contract.
From android.content.ComponentCallbacks
void
void

This method is deprecated.
From androidx.fragment.app.Fragment
void
dump(
    @NonNull String prefix,
    @Nullable FileDescriptor fd,
    @NonNull PrintWriter writer,
    @Nullable String[] args
)

Print the Fragments's state into the given stream.
final @Nullable FragmentActivity
boolean
boolean
final @Nullable Bundle
final @NonNull FragmentManager
@Nullable Context
@NonNull CreationExtras
@NonNull ViewModelProvider.Factory
@Nullable Object
@Nullable Object
final @Nullable FragmentManager

This method is deprecated. Deprecated in Java
final @Nullable Object
final int
final @NonNull LayoutInflater
@NonNull Lifecycle
@NonNull LoaderManager

This method is deprecated. Deprecated in Java
final @Nullable Fragment
final @NonNull FragmentManager
@Nullable Object
final @NonNull Resources
final boolean

This method is deprecated. Deprecated in Java
@Nullable Object
final @NonNull SavedStateRegistry
@Nullable Object
@Nullable Object
final @NonNull String
getString(@StringRes int resId)

Return a localized string from the application's package's default string table.
final @NonNull String
getString(@StringRes int resId, @Nullable Object... formatArgs)

Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in java.util.Formatter and format.
final @Nullable String
final @Nullable Fragment

This method is deprecated. Deprecated in Java
final int

This method is deprecated. Deprecated in Java
final @NonNull CharSequence
getText(@StringRes int resId)

Return a localized, styled CharSequence from the application's package's default string table.
boolean

This method is deprecated. Deprecated in Java
@Nullable View
@NonNull LifecycleOwner
@NonNull LiveData<@NonNull LifecycleOwner>
@NonNull ViewModelStore
final boolean
final boolean
final boolean
final boolean
final boolean
final boolean
final boolean
final boolean
void

This method is deprecated.

use onViewCreated for code touching the view created by onCreateView and onCreate for other initialization.
void
onActivityResult(int requestCode, int resultCode, @Nullable Intent data)

This method is deprecated.

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

This method is deprecated.

See onAttach.
void

Called when a fragment is first attached to its context.
void

This method is deprecated.

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

This hook is called whenever an item in a context menu is selected.
@Nullable Animation
@MainThread
onCreateAnimation(int transit, boolean enter, int nextAnim)

Called when a fragment loads an animation.
@Nullable Animator
@MainThread
onCreateAnimator(int transit, boolean enter, int nextAnim)

Called when a fragment loads an animator.
void

This method is deprecated.

androidx.activity.ComponentActivity now implements MenuHost, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
@Nullable View
@MainThread
onCreateView(
    @NonNull LayoutInflater inflater,
    @Nullable ViewGroup container,
    @Nullable Bundle savedInstanceState
)

Called to have the fragment instantiate its user interface view.
void

Called when the fragment is no longer in use.
void

This method is deprecated.

androidx.activity.ComponentActivity now implements MenuHost, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
void

Called when the view previously created by onCreateView has been detached from the fragment.
void

Called when the fragment is no longer attached to its activity.
@NonNull LayoutInflater
onGetLayoutInflater(@Nullable Bundle savedInstanceState)

Returns the LayoutInflater used to inflate Views of this Fragment.
void
@MainThread
onHiddenChanged(boolean hidden)

Called when the hidden state (as returned by isHidden of the fragment or another fragment in its hierarchy has changed.
void
@UiThread
@CallSuper
onInflate(
    @NonNull Activity activity,
    @NonNull AttributeSet attrs,
    @Nullable Bundle savedInstanceState
)

This method is deprecated.

See onInflate.
void
@UiThread
@CallSuper
onInflate(
    @NonNull Context context,
    @NonNull AttributeSet attrs,
    @Nullable Bundle savedInstanceState
)

Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
void
onMultiWindowModeChanged(boolean isInMultiWindowMode)

Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
boolean

This method is deprecated.

androidx.activity.ComponentActivity now implements MenuHost, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
void

This method is deprecated.

androidx.activity.ComponentActivity now implements MenuHost, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
void

Called when the Fragment is no longer resumed.
void
onPictureInPictureModeChanged(boolean isInPictureInPictureMode)

Called by the system when the activity changes to and from picture-in-picture mode.
void

This method is deprecated.

androidx.activity.ComponentActivity now implements MenuHost, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
void
@MainThread
onPrimaryNavigationFragmentChanged(
    boolean isPrimaryNavigationFragment
)

Callback for when the primary navigation state of this Fragment has changed.
void
onRequestPermissionsResult(
    int requestCode,
    @NonNull String[] permissions,
    @NonNull int[] grantResults
)

This method is deprecated.

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

Called when the fragment is visible to the user and actively running.
void

Called when the Fragment is visible to the user.
void

Called when the Fragment is no longer started.
void

Called when all saved state has been restored into the view hierarchy of the fragment.
void

Postpone the entering Fragment transition until startPostponedEnterTransition or executePendingTransactions has been called.
final void
postponeEnterTransition(long duration, @NonNull TimeUnit timeUnit)

Postpone the entering Fragment transition for a given amount of time and then call startPostponedEnterTransition.
void

Registers a context menu to be shown for the given view (multiple views can show the context menu).
final void
requestPermissions(@NonNull String[] permissions, int requestCode)

This method is deprecated.

This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an ActivityResultContract and the prebuilt contracts for common intents available in androidx.activity.result.contract.ActivityResultContracts, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
final @NonNull FragmentActivity

Return the FragmentActivity this fragment is currently associated with.
final @NonNull Bundle

Return the arguments supplied when the fragment was instantiated.
final @NonNull Context

Return the Context this fragment is currently associated with.
final @NonNull FragmentManager

This method 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.
final @NonNull Object

Return the host object of this fragment.
final @NonNull Fragment

Returns the parent Fragment containing this Fragment.
final @NonNull View

Get the root view for the fragment's layout (the one returned by onCreateView).
void
void
void
void

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.
void
void

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.
void
void
setHasOptionsMenu(boolean hasMenu)

This method is deprecated.

This method is no longer needed when using a MenuProvider to provide a Menu to your activity, which replaces onCreateOptionsMenu as the recommended way to provide a consistent, optionally Lifecycle-aware, and modular way to handle menu creation and item selection.
void

Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by FragmentManager.saveFragmentInstanceState.
void
setMenuVisibility(boolean menuVisible)

Set a hint for whether this fragment's menu should be visible.
void
void
setRetainInstance(boolean retain)

This method is deprecated. Deprecated in Java
void
void
void
void
setTargetFragment(@Nullable Fragment fragment, int requestCode)

This method is deprecated.

Instead of using a target fragment to pass results, the fragment requesting a result should use setFragmentResultListener to register a FragmentResultListener with a requestKey using its parent fragment manager.
void
setUserVisibleHint(boolean isVisibleToUser)

This method is deprecated. Deprecated in Java
boolean

Gets whether you should show UI with rationale before requesting a permission.
void

Call startActivity from the fragment's containing Activity.
void

Call startActivity from the fragment's containing Activity.
void
startActivityForResult(@NonNull Intent intent, int requestCode)

This method is deprecated.

This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an ActivityResultContract and the prebuilt contracts for common intents available in androidx.activity.result.contract.ActivityResultContracts, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
void
startActivityForResult(
    @NonNull Intent intent,
    int requestCode,
    @Nullable Bundle options
)

This method is deprecated.

This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an ActivityResultContract and the prebuilt contracts for common intents available in androidx.activity.result.contract.ActivityResultContracts, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
void
startIntentSenderForResult(
    @NonNull IntentSender intent,
    int requestCode,
    @Nullable Intent fillInIntent,
    int flagsMask,
    int flagsValues,
    int extraFlags,
    @Nullable Bundle options
)

This method is deprecated.

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

Begin postponed transitions after postponeEnterTransition was called.
void

Prevents a context menu to be shown for the given view.
From android.view.View.OnCreateContextMenuListener
void

Called when a context menu for the view is about to be shown.

Public constructors

AbstractProgressFragment

Added in 2.3.0
public AbstractProgressFragment()

AbstractProgressFragment

Added in 2.3.0
public AbstractProgressFragment(int contentLayoutId)

Public methods

onCreate

public void onCreate(Bundle savedInstanceState)

Called to do initial creation of a fragment. This is called after onAttach and before onCreateView.

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 androidx.lifecycle.LifecycleObserver on the activity's Lifecycle, removing it when it receives the CREATED callback.

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

Parameters
Bundle savedInstanceState

If the fragment is being re-created from a previous saved state, this is the state.

onSaveInstanceState

public void onSaveInstanceState(@NonNull Bundle outState)

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, onCreateView, and onViewCreated.

This corresponds to 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.

Parameters
@NonNull Bundle outState

Bundle in which to place your saved state.

onViewCreated

public void onViewCreated(@NonNull View view, Bundle savedInstanceState)

Called immediately after onCreateView has returned, but before any saved state has been restored in to the view. This gives subclasses a chance to initialize themselves once they know their view hierarchy has been completely created. The fragment's view hierarchy is not however attached to its parent at this point.

Parameters
@NonNull View view

The View returned by onCreateView.
Bundle savedInstanceState

If non-null, this fragment is being re-constructed from a previous saved state as given here.

Protected methods

onCancelled

Added in 2.3.0
protected abstract void onCancelled()

Called when the user decided to cancel installation.

onFailed

Added in 2.3.0
protected abstract void onFailed(@SplitInstallErrorCode int errorCode)

Called when the installation has failed due to non-user issues.

Please check SplitInstallErrorCode for error code constants.

Parameters
@SplitInstallErrorCode int errorCode

contains the error code of the installation failure.

onInstalled

Added in 2.3.0
protected void onInstalled()

Called when requested module has been successfully installed, just before the NavController navigates to the final destination.

onProgress

Added in 2.3.0
protected abstract void onProgress(
    @SplitInstallSessionStatus int status,
    long bytesDownloaded,
    long bytesTotal
)

Called when there was a progress update for an active module download.

Parameters
@SplitInstallSessionStatus int status

the current installation status from SplitInstallSessionStatus
long bytesDownloaded

The bytes downloaded so far.
long bytesTotal

The total bytes to be downloaded (can be 0 for some status updates)