ComponentActivity

ComponentActivity()

Default constructor for ComponentActivity. All Activities must have a default constructor for API 27 and lower devices or when using the default android.app.AppComponentFactory.

@ContentView
ComponentActivity(contentLayoutId: @LayoutRes Int)

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.

fun addContentView(view: View!, params: ViewGroup.LayoutParams!): Unit

fun addMenuProvider(provider: MenuProvider): Unit

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

fun addMenuProvider(provider: MenuProvider, owner: LifecycleOwner): Unit

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

fun addMenuProvider(
    provider: MenuProvider,
    owner: LifecycleOwner,
    state: Lifecycle.State
): Unit

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.

fun addOnConfigurationChangedListener(listener: Consumer<Configuration!>): Unit

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

fun addOnContextAvailableListener(listener: OnContextAvailableListener): Unit

Add a new OnContextAvailableListener for receiving a callback for when this class is associated with a android.content.Context.

Listeners are triggered in the order they are added when added before the Context is available. Listeners added after the context has been made available will have the Context synchronously delivered to them as part of this call.

fun addOnMultiWindowModeChangedListener(
    listener: Consumer<MultiWindowModeChangedInfo!>
): Unit

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

fun addOnNewIntentListener(listener: Consumer<Intent!>): Unit

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

fun addOnPictureInPictureModeChangedListener(
    listener: Consumer<PictureInPictureModeChangedInfo!>
): Unit

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

fun addOnTrimMemoryListener(listener: Consumer<Int!>): Unit

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

fun dispatchKeyEvent(event: KeyEvent!): Boolean

fun dispatchKeyShortcutEvent(event: KeyEvent!): Boolean

fun getActivityResultRegistry(): ActivityResultRegistry

Get the ActivityResultRegistry associated with this activity.

@CallSuper
fun getDefaultViewModelCreationExtras(): CreationExtras

Returns the default CreationExtras that should be passed into ViewModelProvider.Factory.create when no overriding CreationExtras were passed to the ViewModelProvider constructors.

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.

fun getDefaultViewModelProviderFactory(): ViewModelProvider.Factory

Returns the default ViewModelProvider.Factory that should be used when no custom Factory is provided to the ViewModelProvider constructors.

fun getFullyDrawnReporter(): FullyDrawnReporter

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

fun getLastCustomNonConfigurationInstance(): Any?

Return the value previously returned from onRetainCustomNonConfigurationInstance.

fun getLifecycle(): Lifecycle

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.

fun getOnBackPressedDispatcher(): OnBackPressedDispatcher

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

fun getSavedStateRegistry(): SavedStateRegistry

The SavedStateRegistry owned by this SavedStateRegistryOwner

fun getViewModelStore(): ViewModelStore

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
fun initializeViewTreeOwners(): Unit

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

fun invalidateMenu(): Unit

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
fun onBackPressed(): Unit

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 onBackPressed is invoked.

@CallSuper
fun onConfigurationChanged(newConfig: Configuration): Unit

Dispatches this call to all listeners added via addOnConfigurationChangedListener.

fun onCreatePanelMenu(featureId: Int, menu: Menu): Boolean

fun onMenuItemSelected(featureId: Int, item: MenuItem): Boolean

@CallSuper
fun onMultiWindowModeChanged(isInMultiWindowMode: Boolean): Unit

Dispatches this call to all listeners added via addOnMultiWindowModeChangedListener.

@RequiresApi(api = Build.VERSION_CODES.O)
@CallSuper
fun onMultiWindowModeChanged(
    isInMultiWindowMode: Boolean,
    newConfig: Configuration
): Unit

Dispatches this call to all listeners added via addOnMultiWindowModeChangedListener.

fun onPanelClosed(featureId: Int, menu: Menu): Unit

@CallSuper
fun onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean): Unit

Dispatches this call to all listeners added via addOnPictureInPictureModeChangedListener.

@RequiresApi(api = Build.VERSION_CODES.O)
@CallSuper
fun onPictureInPictureModeChanged(
    isInPictureInPictureMode: Boolean,
    newConfig: Configuration
): Unit

Dispatches this call to all listeners added via addOnPictureInPictureModeChangedListener.

fun onPreparePanel(featureId: Int, view: View?, menu: Menu): Boolean

@CallSuper
fun onRequestPermissionsResult(
    requestCode: Int,
    permissions: Array<String!>,
    grantResults: IntArray
): Unit

fun onRetainCustomNonConfigurationInstance(): Any?

Use this instead of onRetainNonConfigurationInstance. Retrieve later with getLastCustomNonConfigurationInstance.

fun onRetainNonConfigurationInstance(): Any?

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
fun onTrimMemory(level: Int): Unit

Dispatches this call to all listeners added via addOnTrimMemoryListener.

fun peekAvailableContext(): Context?

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

fun <I, O> registerForActivityResult(
    contract: ActivityResultContract<I!, O!>,
    callback: ActivityResultCallback<O!>
): ActivityResultLauncher<I!>

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.

fun <I, O> registerForActivityResult(
    contract: ActivityResultContract<I!, O!>,
    registry: ActivityResultRegistry,
    callback: ActivityResultCallback<O!>
): ActivityResultLauncher<I!>

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.

fun removeMenuProvider(provider: MenuProvider): Unit

Removes the given MenuProvider from this MenuHost.

fun removeOnConfigurationChangedListener(listener: Consumer<Configuration!>): Unit

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

fun removeOnContextAvailableListener(listener: OnContextAvailableListener): Unit

Remove a OnContextAvailableListener previously added via addOnContextAvailableListener.

fun removeOnMultiWindowModeChangedListener(
    listener: Consumer<MultiWindowModeChangedInfo!>
): Unit

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

fun removeOnNewIntentListener(listener: Consumer<Intent!>): Unit

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

fun removeOnPictureInPictureModeChangedListener(
    listener: Consumer<PictureInPictureModeChangedInfo!>
): Unit

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

fun removeOnTrimMemoryListener(listener: Consumer<Int!>): Unit

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

fun reportFullyDrawn(): Unit

fun setContentView(layoutResID: @LayoutRes Int): Unit

fun setContentView(view: View!): Unit

fun setContentView(view: View!, params: ViewGroup.LayoutParams!): Unit

fun startActivityForResult(intent: Intent, requestCode: Int): Unit

fun startActivityForResult(intent: Intent, requestCode: Int, options: Bundle?): Unit

fun startIntentSenderForResult(
    intent: IntentSender,
    requestCode: Int,
    fillInIntent: Intent?,
    flagsMask: Int,
    flagsValues: Int,
    extraFlags: Int
): Unit

fun startIntentSenderForResult(
    intent: IntentSender,
    requestCode: Int,
    fillInIntent: Intent?,
    flagsMask: Int,
    flagsValues: Int,
    extraFlags: Int,
    options: Bundle?
): Unit

@CallSuper
protected fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?): Unit

protected fun onCreate(savedInstanceState: Bundle?): Unit

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

@CallSuper
protected fun onNewIntent(intent: Intent!): Unit

Dispatches this call to all listeners added via addOnNewIntentListener.

@CallSuper
protected fun onSaveInstanceState(outState: Bundle): Unit

protected fun shouldDumpInternalState(args: Array<String!>?): Boolean

Checks if the internal state should be dump, as some special args are handled by Activity itself.

Subclasses implementing dump should typically start with:

@Override
public void dump(@NonNull String prefix, @Nullable FileDescriptor fd,
       @NonNull PrintWriter writer, @Nullable String[] args) {
   super.dump(prefix, fd, writer, args);

   if (!shouldDumpInternalState(args)) {
       return;
   }
   // dump internal starte
}

@MainThread
inline fun <VM : ViewModel> ComponentActivity.viewModels(
    noinline extrasProducer: (() -> CreationExtras)? = null,
    noinline factoryProducer: (() -> ViewModelProvider.Factory)? = null
): Lazy<VM>

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.

fun ComponentActivity.setContent(
    parent: CompositionContext? = null,
    content: @Composable () -> Unit
): Unit

Composes the given composable into the given activity. The content will become the root view of the given activity.

This is roughly equivalent to calling ComponentActivity.setContentView with a ComposeView i.e.:

setContentView(
  ComposeView(this).apply {
    setContent {
      MyComposableContent()
    }
  }
)

fun ComponentActivity.enableEdgeToEdge(
    statusBarStyle: SystemBarStyle = SystemBarStyle.auto(Color.TRANSPARENT, Color.TRANSPARENT),
    navigationBarStyle: SystemBarStyle = SystemBarStyle.auto(DefaultLightScrim, DefaultDarkScrim)
): Unit

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.