RetainedLifecycle

All Known Subinterfaces:: ActivityRetainedLifecycle, ViewModelLifecycle

All Known Implementing Classes:: RetainedLifecycleImpl

public interface RetainedLifecycle

A class for registered listeners on a retained lifecycle (generally backed up by a ViewModel).

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static interface

RetainedLifecycle.OnClearedListener

Listener for when the retained lifecycle is cleared.
Method Summary

Modifier and Type

Method

Description

void

addOnClearedListener(RetainedLifecycle.OnClearedListener listener)

Adds a new RetainedLifecycle.OnClearedListener for receiving a callback when the lifecycle is cleared.

void

removeOnClearedListener(RetainedLifecycle.OnClearedListener listener)

Removes a RetainedLifecycle.OnClearedListener previously added via addOnClearedListener(OnClearedListener).

Method Details
- addOnClearedListener
  
  @MainThread void addOnClearedListener(@NonNull RetainedLifecycle.OnClearedListener listener)
  
  Adds a new RetainedLifecycle.OnClearedListener for receiving a callback when the lifecycle is cleared.
  
  Parameters:
  
  listener - The listener that should be added.
- removeOnClearedListener
  
  @MainThread void removeOnClearedListener(@NonNull RetainedLifecycle.OnClearedListener listener)
  
  Removes a RetainedLifecycle.OnClearedListener previously added via addOnClearedListener(OnClearedListener).
  
  Parameters:
  
  listener - The listener that should be removed.