ComponentActivity

ComponentActivity

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

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.

addContentView

public void addContentView(View view, ViewGroup.LayoutParams params)

addMenuProvider

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.

addMenuProvider

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.

addMenuProvider

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.

addOnConfigurationChangedListener

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

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

addOnContextAvailableListener

public final void addOnContextAvailableListener(
    @NonNull OnContextAvailableListener listener
)

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.

addOnMultiWindowModeChangedListener

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

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

addOnNewIntentListener

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

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

addOnPictureInPictureModeChangedListener

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

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

addOnTrimMemoryListener

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

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

dispatchKeyEvent

public boolean dispatchKeyEvent(KeyEvent event)

dispatchKeyShortcutEvent

public boolean dispatchKeyShortcutEvent(KeyEvent event)

getActivityResultRegistry

public final @NonNull ActivityResultRegistry getActivityResultRegistry()

Get the ActivityResultRegistry associated with this activity.

getDefaultViewModelCreationExtras

@CallSuper
public @NonNull CreationExtras getDefaultViewModelCreationExtras()

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.

getDefaultViewModelProviderFactory

public @NonNull ViewModelProvider.Factory getDefaultViewModelProviderFactory()

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

getFullyDrawnReporter

public @NonNull FullyDrawnReporter getFullyDrawnReporter()

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

getLastCustomNonConfigurationInstance

public @Nullable Object getLastCustomNonConfigurationInstance()

Return the value previously returned from onRetainCustomNonConfigurationInstance.

getLifecycle

public @NonNull Lifecycle getLifecycle()

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.

getOnBackPressedDispatcher

public final @NonNull OnBackPressedDispatcher getOnBackPressedDispatcher()

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

getSavedStateRegistry

public final @NonNull SavedStateRegistry getSavedStateRegistry()

The SavedStateRegistry owned by this SavedStateRegistryOwner

getViewModelStore

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.

invalidateMenu

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.

onBackPressed

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

onConfigurationChanged

@CallSuper
public void onConfigurationChanged(@NonNull Configuration newConfig)

Dispatches this call to all listeners added via addOnConfigurationChangedListener.

onCreatePanelMenu

public boolean onCreatePanelMenu(int featureId, @NonNull Menu menu)

onMenuItemSelected

public boolean onMenuItemSelected(int featureId, @NonNull MenuItem item)

onMultiWindowModeChanged

@CallSuper
public void onMultiWindowModeChanged(boolean isInMultiWindowMode)

Dispatches this call to all listeners added via addOnMultiWindowModeChangedListener.

onMultiWindowModeChanged

@RequiresApi(api = Build.VERSION_CODES.O)
@CallSuper
public void onMultiWindowModeChanged(
    boolean isInMultiWindowMode,
    @NonNull Configuration newConfig
)

Dispatches this call to all listeners added via addOnMultiWindowModeChangedListener.

onPanelClosed

public void onPanelClosed(int featureId, @NonNull Menu menu)

onPictureInPictureModeChanged

@CallSuper
public void onPictureInPictureModeChanged(boolean isInPictureInPictureMode)

Dispatches this call to all listeners added via addOnPictureInPictureModeChangedListener.

onPictureInPictureModeChanged

@RequiresApi(api = Build.VERSION_CODES.O)
@CallSuper
public void onPictureInPictureModeChanged(
    boolean isInPictureInPictureMode,
    @NonNull Configuration newConfig
)

Dispatches this call to all listeners added via addOnPictureInPictureModeChangedListener.

onPreparePanel

public boolean onPreparePanel(int featureId, @Nullable View view, @NonNull Menu menu)

onRequestPermissionsResult

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

onRetainCustomNonConfigurationInstance

public @Nullable Object onRetainCustomNonConfigurationInstance()

Use this instead of onRetainNonConfigurationInstance. Retrieve later with getLastCustomNonConfigurationInstance.

onRetainNonConfigurationInstance

public final @Nullable 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.

onTrimMemory

@CallSuper
public void onTrimMemory(int level)

Dispatches this call to all listeners added via addOnTrimMemoryListener.

peekAvailableContext

public @Nullable 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.

registerForActivityResult

public final @NonNull ActivityResultLauncher<I> <I, O> registerForActivityResult(
    @NonNull ActivityResultContract<I, O> contract,
    @NonNull ActivityResultCallback<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.

registerForActivityResult

public final @NonNull ActivityResultLauncher<I> <I, O> registerForActivityResult(
    @NonNull ActivityResultContract<I, O> contract,
    @NonNull ActivityResultRegistry registry,
    @NonNull ActivityResultCallback<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.

removeMenuProvider

public void removeMenuProvider(@NonNull MenuProvider provider)

Removes the given MenuProvider from this MenuHost.

removeOnConfigurationChangedListener

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

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

removeOnContextAvailableListener

public final void removeOnContextAvailableListener(
    @NonNull OnContextAvailableListener listener
)

Remove a OnContextAvailableListener previously added via addOnContextAvailableListener.

removeOnMultiWindowModeChangedListener

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

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

removeOnNewIntentListener

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

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

removeOnPictureInPictureModeChangedListener

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

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

removeOnTrimMemoryListener

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

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

reportFullyDrawn

public void reportFullyDrawn()

setContentView

public void setContentView(@LayoutRes int layoutResID)

setContentView

public void setContentView(View view)

setContentView

public void setContentView(View view, ViewGroup.LayoutParams params)

startActivityForResult

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

startActivityForResult

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

startIntentSenderForResult

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

startIntentSenderForResult

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

onActivityResult

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

onCreate

protected void onCreate(@Nullable Bundle savedInstanceState)

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

onNewIntent

@CallSuper
protected void onNewIntent(Intent intent)

Dispatches this call to all listeners added via addOnNewIntentListener.

onSaveInstanceState

@CallSuper
protected void onSaveInstanceState(@NonNull Bundle outState)

shouldDumpInternalState

protected final boolean shouldDumpInternalState(@Nullable String[] args)

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
}

ActivityViewModelLazyKt.viewModels

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