ComponentActivity

@ContentView
public ComponentActivity(@LayoutRes int contentLayoutId)

Alternate constructor that can be used to provide a default layout that will be inflated as part of super.onCreate(savedInstanceState).

This should generally be called from your constructor that takes no parameters, as is required for API 27 and lower or when using the default android.app.AppComponentFactory.

public void addMenuProvider(@NonNull MenuProvider provider)

Adds the given MenuProvider to this MenuHost. If using this method, you must manually remove the provider when necessary.

public void addMenuProvider(
    @NonNull MenuProvider provider,
    @NonNull LifecycleOwner owner
)

Adds the given MenuProvider to this MenuHost. This MenuProvider will be removed once the given LifecycleOwner receives an Lifecycle.Event.ON_DESTROY event.

public void addMenuProvider(
    @NonNull MenuProvider provider,
    @NonNull LifecycleOwner owner,
    @NonNull Lifecycle.State state
)

Adds the given MenuProvider to this MenuHost once the given LifecycleOwner reaches the given Lifecycle.State. This MenuProvider will be removed once the given LifecycleOwner goes down from the given Lifecycle.State.

public final void addOnConfigurationChangedListener(
    @NonNull Consumer<@NonNull Configuration> listener
)

Add a new listener that will get a callback associated with ComponentCallbacks.onConfigurationChanged with the new Configuration.

public final void addOnContextAvailableListener(
    @NonNull OnContextAvailableListener listener
)

{@inheritDoc}

Any listener added here will receive a callback as part of super.onCreate(), but importantly before any other logic is done (including calling through to the framework Activity.onCreate with the exception of restoring the state of the savedStateRegistry for use in your listener.

public final void addOnMultiWindowModeChangedListener(
    @NonNull Consumer<@NonNull MultiWindowModeChangedInfo> listener
)

Add a new listener that will get a callback associated with Activity.onMultiWindowModeChanged with the new MultiWindowModeChangedInfo.

public final void addOnNewIntentListener(@NonNull Consumer<@NonNull Intent> listener)

Add a new listener that will get a callback associated with Activity.onNewIntent with the new Intent.

public final void addOnPictureInPictureModeChangedListener(
    @NonNull Consumer<@NonNull PictureInPictureModeChangedInfo> listener
)

Add a new listener that will get a callback associated with Activity.onPictureInPictureModeChanged with the new PictureInPictureModeChangedInfo.

public final void addOnPictureInPictureUiStateChangedListener(
    @NonNull Consumer<@NonNull PictureInPictureUiStateCompat> listener
)

Add a new listener that will get a callback associated with Activity.onPictureInPictureUiStateChanged with the new PictureInPictureUiStateCompat.

public final void addOnTrimMemoryListener(@NonNull Consumer<@NonNull Integer> listener)

Add a new listener that will get a callback associated with ComponentCallbacks2.onTrimMemory with the int representing the level of trimming.

public final void addOnUserLeaveHintListener(@NonNull Runnable listener)

Add a new listener that will get a callback associated with Activity.onUserLeaveHint

public final void enterPictureInPictureMode(@NonNull PictureInPictureParamsCompat params)

Available since API 24 in the framework Activity class, puts the activity in picture-in-picture mode if possible in the current system state. Any prior calls to setPictureInPictureParams will still apply when entering picture-in-picture through this call.

public final @NonNull ActivityResultRegistry getActivityResultRegistry()

Get the ActivityResultRegistry associated with this activity.

@CallSuper
public @NonNull CreationExtras getDefaultViewModelCreationExtras()

{@inheritDoc}

The extras of getIntent when this is first called will be used as the defaults to any androidx.lifecycle.SavedStateHandle passed to a view model created using this extra.

public final @NonNull FullyDrawnReporter getFullyDrawnReporter()

Retrieve the FullyDrawnReporter that should handle the independent parts of the UI that separately report that they are fully drawn.

public Object getLastCustomNonConfigurationInstance()

Return the value previously returned from onRetainCustomNonConfigurationInstance.

public @NonNull Lifecycle getLifecycle()

{@inheritDoc}

Overriding this method is no longer supported and this method will be made final in a future version of ComponentActivity. If you do override this method, you must:

1. Return an instance of LifecycleRegistry

2. Lazily initialize your LifecycleRegistry object when this is first called.

Note that this method will be called in the super classes' constructor, before any field initialization or object state creation is complete.

public @NonNull NavigationEventDispatcher getNavigationEventDispatcher()

Lazily provides a NavigationEventDispatcher for back navigation handling, including support for predictive back gestures introduced in Android 13 (API 33+).

This dispatcher acts as the central point for back navigation events. When a navigation event occurs (e.g., a back gesture), it safely invokes ComponentActivity.onBackPressed.

public final @NonNull OnBackPressedDispatcher getOnBackPressedDispatcher()

Retrieve the OnBackPressedDispatcher that will be triggered when onBackPressed is called.

public @NonNull ViewModelStore getViewModelStore()

Returns the ViewModelStore associated with this activity

Overriding this method is no longer supported and this method will be made final in a future version of ComponentActivity.

@CallSuper
public void initializeViewTreeOwners()

Sets the view tree owners before setting the content view so that the inflation process and attach listeners will see them already present.

public void invalidateMenu()

Invalidates the android.view.Menu to ensure that what is displayed matches the current internal state of the menu. This should be called whenever the state of the menu is changed, such as items being removed or disabled based on some user event.

@MainThread
@CallSuper
public void onBackPressed()

Called when the activity has detected the user's press of the back key. The onBackPressedDispatcher will be given a chance to handle the back button before the default behavior of android.app.Activity.onBackPressed is invoked.

@CallSuper
public void onConfigurationChanged(@NonNull Configuration newConfig)

{@inheritDoc}

Dispatches this call to all listeners added via addOnConfigurationChangedListener.

@CallSuper
public void onMultiWindowModeChanged(boolean isInMultiWindowMode)

{@inheritDoc}

Dispatches this call to all listeners added via addOnMultiWindowModeChangedListener.

@RequiresApi(api = 26)
@CallSuper
public void onMultiWindowModeChanged(
    boolean isInMultiWindowMode,
    @NonNull Configuration newConfig
)

{@inheritDoc}

Dispatches this call to all listeners added via addOnMultiWindowModeChangedListener.

@CallSuper
public void onPictureInPictureModeChanged(boolean isInPictureInPictureMode)

{@inheritDoc}

Dispatches this call to all listeners added via addOnPictureInPictureModeChangedListener.

@RequiresApi(api = 26)
@CallSuper
public void onPictureInPictureModeChanged(
    boolean isInPictureInPictureMode,
    @NonNull Configuration newConfig
)

{@inheritDoc}

Dispatches this call to all listeners added via addOnPictureInPictureModeChangedListener.

@RequiresApi(api = 31)
@CallSuper
public void onPictureInPictureUiStateChanged(
    @NonNull PictureInPictureUiState pipState
)

{@inheritDoc}

@CallSuper
public void onRequestPermissionsResult(
    int requestCode,
    @NonNull String[] permissions,
    @NonNull int[] grantResults
)

{@inheritDoc}

public Object onRetainCustomNonConfigurationInstance()

Use this instead of onRetainNonConfigurationInstance. Retrieve later with lastCustomNonConfigurationInstance.

public final Object onRetainNonConfigurationInstance()

Retain all appropriate non-config state. You can NOT override this yourself! Use a androidx.lifecycle.ViewModel if you want to retain your own non config state.

@CallSuper
public void onTrimMemory(int level)

{@inheritDoc}

Dispatches this call to all listeners added via addOnTrimMemoryListener.

public Context peekAvailableContext()

Get the Context if it is currently available. If this returns null, you can use addOnContextAvailableListener to receive a callback for when it available.

public final @NonNull ActivityResultLauncher<@NonNull I> <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.

This creates a record in the registry associated with this caller, managing request code, as well as conversions to/from Intent under the hood.

This must be called unconditionally, as part of initialization path, typically as a field initializer of an Activity or Fragment.

public final @NonNull ActivityResultLauncher<@NonNull I> <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.

This creates a record in the given registry, managing request code, as well as conversions to/from Intent under the hood.

This must be called unconditionally, as part of initialization path, typically as a field initializer of an Activity or Fragment.

public void removeMenuProvider(@NonNull MenuProvider provider)

Removes the given MenuProvider from this MenuHost.

public final void removeOnConfigurationChangedListener(
    @NonNull Consumer<@NonNull Configuration> listener
)

Remove a previously added listener. It will not receive any future callbacks.

public final void removeOnContextAvailableListener(
    @NonNull OnContextAvailableListener listener
)

Remove a OnContextAvailableListener previously added via addOnContextAvailableListener.

public final void removeOnMultiWindowModeChangedListener(
    @NonNull Consumer<@NonNull MultiWindowModeChangedInfo> listener
)

Remove a previously added listener. It will not receive any future callbacks.

public final void removeOnNewIntentListener(@NonNull Consumer<@NonNull Intent> listener)

Remove a previously added listener. It will not receive any future callbacks.

public final void removeOnPictureInPictureModeChangedListener(
    @NonNull Consumer<@NonNull PictureInPictureModeChangedInfo> listener
)

Remove a previously added listener. It will not receive any future callbacks.

public final void removeOnPictureInPictureUiStateChangedListener(
    @NonNull Consumer<@NonNull PictureInPictureUiStateCompat> listener
)

Remove a previously added listener. It will not receive any future callbacks.

public final void removeOnTrimMemoryListener(@NonNull Consumer<@NonNull Integer> listener)

Remove a previously added listener. It will not receive any future callbacks.

public final void removeOnUserLeaveHintListener(@NonNull Runnable listener)

Remove a previously added listener. It will not receive any future callbacks.

public final void setPictureInPictureParams(@NonNull PictureInPictureParamsCompat params)

Available since API 26 in the framework Activity class, updates the properties of the picture-in-picture activity, or sets it to be used later when enterPictureInPictureMode is called

public void startActivityForResult(@NonNull Intent intent, int requestCode)

{@inheritDoc}

public void startActivityForResult(
    @NonNull Intent intent,
    int requestCode,
    Bundle options
)

{@inheritDoc}

public void startIntentSenderForResult(
    @NonNull IntentSender intent,
    int requestCode,
    Intent fillInIntent,
    int flagsMask,
    int flagsValues,
    int extraFlags
)

{@inheritDoc}

public void startIntentSenderForResult(
    @NonNull IntentSender intent,
    int requestCode,
    Intent fillInIntent,
    int flagsMask,
    int flagsValues,
    int extraFlags,
    Bundle options
)

{@inheritDoc}

@CallSuper
protected void onActivityResult(int requestCode, int resultCode, Intent data)

{@inheritDoc}

protected void onCreate(Bundle savedInstanceState)

{@inheritDoc}

If your ComponentActivity is annotated with ContentView, this will call setContentView for you.

@CallSuper
protected void onNewIntent(@NonNull Intent intent)

{@inheritDoc}

Dispatches this call to all listeners added via addOnNewIntentListener.

@CallSuper
protected void onUserLeaveHint()

{@inheritDoc}

Dispatches this call to all listeners added via addOnUserLeaveHintListener.

@MainThread
public final @NonNull Lazy<@NonNull VM> <VM extends ViewModel> ActivityViewModelLazyKt.viewModels(
    @NonNull ComponentActivity receiver,
    Function0<@NonNull CreationExtras> extrasProducer,
    Function0<@NonNull ViewModelProvider.Factory> factoryProducer
)

Returns a Lazy delegate to access the ComponentActivity's ViewModel, if factoryProducer is specified then ViewModelProvider.Factory returned by it will be used to create ViewModel first time.

class MyComponentActivity : ComponentActivity() {
    val viewmodel: MyViewModel by viewModels()
}

This property can be accessed only after the Activity is attached to the Application, and access prior to that will result in IllegalArgumentException.

public final void EdgeToEdge.enableEdgeToEdge(
    @NonNull ComponentActivity receiver,
    @NonNull SystemBarStyle statusBarStyle,
    @NonNull SystemBarStyle navigationBarStyle
)

Enables the edge-to-edge display for this ComponentActivity.

To set it up with the default style, call this method in your Activity's onCreate method:

    override fun onCreate(savedInstanceState: Bundle?) {
        enableEdgeToEdge()
        super.onCreate(savedInstanceState)
        ...
    }

The default style configures the system bars with a transparent background when contrast can be enforced by the system (API 29 or above). On older platforms (which only have 3-button/2-button navigation modes), an equivalent scrim is applied to ensure contrast with the system bars.

See SystemBarStyle for more customization options.