AmbientModeSupport

Added in 1.1.0

Deprecated in 1.3.0

Kotlin |Java

class AmbientModeSupport : Fragment

kotlin.Any
↳	androidx.fragment.app.Fragment
	↳	androidx.wear.ambient.AmbientModeSupport

Use this as a headless Fragment to add ambient support to an Activity on Wearable devices.

The application that uses this should add the WAKE_LOCK permission to its manifest.

The following describes the general use of this class:

Create a subclass of one of the FragmentActivity classes and implement the AmbientCallbackProvider interface. Override the getAmbientCallback method to provide the callbacks required for reacting to the ambient events from the Android system. If a valid AmbientCallback is not provided (either no implementation of the AmbientCallbackProvider interface, or returning null from getAmbientCallback), then ambient mode will NOT be enabled.

The primary entry point for this code is the attach method. It should be called with an FragmentActivity as an argument and that FragmentActivity will then be able to receive ambient lifecycle events through an AmbientCallback. The FragmentActivity will also receive a AmbientController object from the attachment which can be used to query the current status of the ambient mode.

An example of how to implement the AmbientCallbackProvider interface, attach AmbientModeSupport to your FragmentActivity and use the AmbientController can be found below:

public class MyActivity extends FragmentActivity
    implements AmbientModeSupport.AmbientCallbackProvider {
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState)
        ...
        AmbientModeSupport.AmbientController controller = AmbientModeSupport.attach(this);
        boolean isAmbient = controller.isAmbient();
    }
    @Override
    AmbientModeSupport.AmbientCallback getAmbientCallback() {
        return new AmbientModeSupport.AmbientCallback() {
            public void onEnterAmbient(Bundle ambientDetails) {...}
            public void onExitAmbient(Bundle ambientDetails) {...}
        }
    }
}

Summary

Nested types
`abstract class AmbientModeSupport.AmbientCallback` Callback to receive ambient mode state changes.
`interface AmbientModeSupport.AmbientCallbackProvider` Interface for any `Activity` that wishes to implement Ambient Mode.
`inner class AmbientModeSupport.AmbientController` A class for interacting with the ambient mode on a wearable device.

Constants
`const String!`	`EXTRA_BURN_IN_PROTECTION = "com.google.android.wearable.compat.extra.BURN_IN_PROTECTION"` Property in bundle passed to `AmbientCallback#onEnterAmbient(Bundle)` to indicate whether burn-in protection is required.
`const String!`	`EXTRA_LOWBIT_AMBIENT = "com.google.android.wearable.compat.extra.LOWBIT_AMBIENT"` Property in bundle passed to `AmbientCallback#onEnterAmbient(Bundle)` to indicate whether the device has low-bit ambient mode.
`const String!`	`FRAGMENT_TAG = "android.support.wearable.ambient.AmbientMode"` Fragment tag used by default when adding `AmbientModeSupport` to add ambient support to a `FragmentActivity`.

Public constructors
`AmbientModeSupport()` Constructor

Public functions
`java-static AmbientModeSupport.AmbientController!`	`<T : FragmentActivity?> attach(activity: T!)` Attach ambient support to the given activity.
`Unit`	`dump( prefix: String!, fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>! )` Print the Fragments's state into the given stream.
`Unit`	`@CallSuper onAttach(context: Context!)` Called when a fragment is first attached to its context.
`Unit`	`@CallSuper onCreate(savedInstanceState: Bundle!)` Called to do initial creation of a fragment.
`Unit`	`@CallSuper onDestroy()` Called when the fragment is no longer in use.
`Unit`	`@CallSuper onDetach()` Called when the fragment is no longer attached to its activity.
`Unit`	`@CallSuper onPause()` Called when the Fragment is no longer resumed.
`Unit`	`@CallSuper onResume()` Called when the fragment is visible to the user and actively running.
`Unit`	`@CallSuper onStop()` Called when the Fragment is no longer started.

Inherited functions

From androidx.activity.result.ActivityResultCaller

abstract ActivityResultLauncher<I!>!

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

From android.content.ComponentCallbacks

`abstract Unit`	`onConfigurationChanged(p: Configuration!)`
`abstract Unit`	`onLowMemory()`

From androidx.fragment.app.Fragment

`Boolean`	`equals(o: Any?)` Subclasses can not override equals().
`FragmentActivity?`	`getActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`Boolean`	`getAllowEnterTransitionOverlap()` Returns whether the the exit transition and enter transition overlap or not.
`Boolean`	`getAllowReturnTransitionOverlap()` Returns whether the the return transition and reenter transition overlap or not.
`Bundle?`	`getArguments()` Return the arguments supplied when the fragment was instantiated, if any.
`FragmentManager`	`getChildFragmentManager()` Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
`Context?`	`getContext()` Return the `Context` this fragment is currently associated with.
`CreationExtras`	`@CallSuper getDefaultViewModelCreationExtras()` The `Fragment's arguments` 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.
`ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()`
`Any?`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene.
`Any?`	`getExitTransition()` Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`FragmentManager?`	`getFragmentManager()` This function is deprecated. This has been removed in favor of `getParentFragmentManager()` which throws an `IllegalStateException` if the FragmentManager is null.
`Any?`	`getHost()` Return the host object of this fragment.
`Int`	`getId()` Return the identifier this fragment is known by.
`LayoutInflater`	`getLayoutInflater()` Returns the cached LayoutInflater used to inflate Views of this Fragment.
`Lifecycle`	`getLifecycle()` Overriding this method is no longer supported and this method will be made `final` in a future version of Fragment.
`LoaderManager`	`getLoaderManager()` This function is deprecated. Use `LoaderManager.getInstance(this)`.
`Fragment?`	`getParentFragment()` Returns the parent Fragment containing this Fragment.
`FragmentManager`	`getParentFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`Any?`	`getReenterTransition()` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`Resources`	`getResources()` Return `requireActivity().getResources()`.
`Boolean`	`getRetainInstance()` This function is deprecated. Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.
`Any?`	`getReturnTransition()` Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`SavedStateRegistry`	`getSavedStateRegistry()`
`Any?`	`getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene.
`Any?`	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
`String`	`getString(resId: @StringRes Int)` Return a localized string from the application's package's default string table.
`String`	`getString(resId: @StringRes Int, formatArgs: Array<Any!>?)` 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.
`String?`	`getTag()` Get the tag name of the fragment, if specified.
`Fragment?`	`getTargetFragment()` This function is deprecated. Instead of using a target fragment to pass results, use `setFragmentResult` to deliver results to `FragmentResultListener` instances registered by other fragments via `setFragmentResultListener`.
`Int`	`getTargetRequestCode()` This function is deprecated. When using the target fragment replacement of `setFragmentResultListener` and `setFragmentResult`, consider using `setArguments` to pass a `requestKey` if you need to support dynamic request keys.
`CharSequence`	`getText(resId: @StringRes Int)` Return a localized, styled CharSequence from the application's package's default string table.
`Boolean`	`getUserVisibleHint()` This function is deprecated. Use `setMaxLifecycle` instead.
`View?`	`getView()` Get the root view for the fragment's layout (the one returned by `onCreateView`), if provided.
`LifecycleOwner`	`@MainThread getViewLifecycleOwner()` Get a `LifecycleOwner` that represents the `Fragment's View` lifecycle.
`LiveData<LifecycleOwner!>`	`getViewLifecycleOwnerLiveData()` Retrieve a `LiveData` which allows you to observe the `lifecycle of the Fragment's View`.
`ViewModelStore`	`getViewModelStore()` Returns the `ViewModelStore` associated with this Fragment
`Int`	`hashCode()` Subclasses can not override hashCode().
`java-static Fragment`	`instantiate(context: Context, fname: String)` This function is deprecated. Use `getFragmentFactory` and `instantiate`
`java-static Fragment`	`instantiate(context: Context, fname: String, args: Bundle?)` This function is deprecated. Use `getFragmentFactory` and `instantiate`, manually calling `setArguments` on the returned Fragment.
`Boolean`	`isAdded()` Return true if the fragment is currently added to its activity.
`Boolean`	`isDetached()` Return true if the fragment has been explicitly detached from the UI.
`Boolean`	`isHidden()` Return true if the fragment has been hidden.
`Boolean`	`isInLayout()` Return true if the layout is included as part of an activity view hierarchy via the tag.
`Boolean`	`isRemoving()` Return true if this fragment is currently being removed from its activity.
`Boolean`	`isResumed()` Return true if the fragment is in the resumed state.
`Boolean`	`isStateSaved()` Returns true if this fragment is added and its state has already been saved by its host.
`Boolean`	`isVisible()` Return true if the fragment is currently visible to the user.
`Unit`	`@MainThread @CallSuper onActivityCreated(savedInstanceState: Bundle?)` This function is deprecated. use `onViewCreated` for code touching the view created by `onCreateView` and `onCreate` for other initialization.
`Unit`	`onActivityResult(requestCode: Int, resultCode: Int, data: Intent?)` This function 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.
`Unit`	`@MainThread @CallSuper onAttach(activity: Activity)` This function is deprecated. See `onAttach`.
`Unit`	`@MainThread onAttachFragment(childFragment: Fragment)` This function is deprecated. The responsibility for listening for fragments being attached has been moved to FragmentManager.
`Unit`	`@CallSuper onConfigurationChanged(newConfig: Configuration)`
`Boolean`	`@MainThread onContextItemSelected(item: MenuItem)` This hook is called whenever an item in a context menu is selected.
`Animation?`	`@MainThread onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int)` Called when a fragment loads an animation.
`Animator?`	`@MainThread onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int)` Called when a fragment loads an animator.
`Unit`	`@MainThread onCreateContextMenu( menu: ContextMenu, v: View, menuInfo: ContextMenu.ContextMenuInfo? )` Called when a context menu for the `view` is about to be shown.
`Unit`	`@MainThread onCreateOptionsMenu(menu: Menu, inflater: MenuInflater)` This function 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.
`View?`	`@MainThread onCreateView( inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle? )` Called to have the fragment instantiate its user interface view.
`Unit`	`@MainThread onDestroyOptionsMenu()` This function 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.
`Unit`	`@MainThread @CallSuper onDestroyView()` Called when the view previously created by `onCreateView` has been detached from the fragment.
`LayoutInflater`	`onGetLayoutInflater(savedInstanceState: Bundle?)` Returns the LayoutInflater used to inflate Views of this Fragment.
`Unit`	`@MainThread onHiddenChanged(hidden: Boolean)` Called when the hidden state (as returned by `isHidden` of the fragment or another fragment in its hierarchy has changed.
`Unit`	`@UiThread @CallSuper onInflate( activity: Activity, attrs: AttributeSet, savedInstanceState: Bundle? )` This function is deprecated. See `onInflate`.
`Unit`	`@UiThread @CallSuper onInflate( context: Context, attrs: AttributeSet, savedInstanceState: Bundle? )` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
`Unit`	`@MainThread @CallSuper onLowMemory()`
`Unit`	`onMultiWindowModeChanged(isInMultiWindowMode: Boolean)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`Boolean`	`@MainThread onOptionsItemSelected(item: MenuItem)` This function 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.
`Unit`	`@MainThread onOptionsMenuClosed(menu: Menu)` This function 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.
`Unit`	`onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)` Called by the system when the activity changes to and from picture-in-picture mode.
`Unit`	`@MainThread onPrepareOptionsMenu(menu: Menu)` This function 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.
`Unit`	`@MainThread onPrimaryNavigationFragmentChanged( isPrimaryNavigationFragment: Boolean )` Callback for when the primary navigation state of this Fragment has changed.
`Unit`	`onRequestPermissionsResult( requestCode: Int, permissions: Array<String!>, grantResults: IntArray )` This function 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.
`Unit`	`@MainThread onSaveInstanceState(outState: Bundle)` 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.
`Unit`	`@MainThread @CallSuper onStart()` Called when the Fragment is visible to the user.
`Unit`	`@MainThread onViewCreated(view: View, savedInstanceState: Bundle?)` Called immediately after `onCreateView` has returned, but before any saved state has been restored in to the view.
`Unit`	`@MainThread @CallSuper onViewStateRestored(savedInstanceState: Bundle?)` Called when all saved state has been restored into the view hierarchy of the fragment.
`Unit`	`postponeEnterTransition()` Postpone the entering Fragment transition until `startPostponedEnterTransition` or `executePendingTransactions` has been called.
`Unit`	`postponeEnterTransition(duration: Long, timeUnit: TimeUnit)` Postpone the entering Fragment transition for a given amount of time and then call `startPostponedEnterTransition`.
`ActivityResultLauncher<I!>`	`@MainThread <I, O> registerForActivityResult( contract: ActivityResultContract<I!, O!>, callback: ActivityResultCallback<O!> )` Register a request to `start an activity for result`, designated by the given `contract`.
`ActivityResultLauncher<I!>`	`@MainThread <I, O> registerForActivityResult( contract: ActivityResultContract<I!, O!>, registry: ActivityResultRegistry, callback: ActivityResultCallback<O!> )` Register a request to `start an activity for result`, designated by the given `contract`.
`Unit`	`registerForContextMenu(view: View)` Registers a context menu to be shown for the given view (multiple views can show the context menu).
`Unit`	`requestPermissions(permissions: Array<String!>, requestCode: Int)` This function 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.
`FragmentActivity`	`requireActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`Bundle`	`requireArguments()` Return the arguments supplied when the fragment was instantiated.
`Context`	`requireContext()` Return the `Context` this fragment is currently associated with.
`FragmentManager`	`requireFragmentManager()` This function 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.
`Any`	`requireHost()` Return the host object of this fragment.
`Fragment`	`requireParentFragment()` Returns the parent Fragment containing this Fragment.
`View`	`requireView()` Get the root view for the fragment's layout (the one returned by `onCreateView`).
`Unit`	`setAllowEnterTransitionOverlap(allow: Boolean)` Sets whether the the exit transition and enter transition overlap or not.
`Unit`	`setAllowReturnTransitionOverlap(allow: Boolean)` Sets whether the the return transition and reenter transition overlap or not.
`Unit`	`setArguments(args: Bundle?)` Supply the construction arguments for this fragment.
`Unit`	`setEnterSharedElementCallback(callback: SharedElementCallback?)` 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.
`Unit`	`setEnterTransition(transition: Any?)` Sets the Transition that will be used to move Views into the initial scene.
`Unit`	`setExitSharedElementCallback(callback: SharedElementCallback?)` 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.
`Unit`	`setExitTransition(transition: Any?)` Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`Unit`	`setHasOptionsMenu(hasMenu: Boolean)` This function 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.
`Unit`	`setInitialSavedState(state: Fragment.SavedState?)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
`Unit`	`setMenuVisibility(menuVisible: Boolean)` Set a hint for whether this fragment's menu should be visible.
`Unit`	`setReenterTransition(transition: Any?)` Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`Unit`	`setRetainInstance(retain: Boolean)` This function is deprecated. Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.
`Unit`	`setReturnTransition(transition: Any?)` Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`Unit`	`setSharedElementEnterTransition(transition: Any?)` Sets the Transition that will be used for shared elements transferred into the content Scene.
`Unit`	`setSharedElementReturnTransition(transition: Any?)` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
`Unit`	`setTargetFragment(fragment: Fragment?, requestCode: Int)` This function 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`.
`Unit`	`setUserVisibleHint(isVisibleToUser: Boolean)` This function is deprecated. If you are manually calling this method, use `setMaxLifecycle` instead.
`Boolean`	`shouldShowRequestPermissionRationale(permission: String)` Gets whether you should show UI with rationale before requesting a permission.
`Unit`	`startActivity(intent: Intent)` Call startActivity from the fragment's containing Activity.
`Unit`	`startActivity(intent: Intent, options: Bundle?)` Call startActivity from the fragment's containing Activity.
`Unit`	`startActivityForResult(intent: Intent, requestCode: Int)` This function 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.
`Unit`	`startActivityForResult(intent: Intent, requestCode: Int, options: Bundle?)` This function 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.
`Unit`	`startIntentSenderForResult( intent: IntentSender, requestCode: Int, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle? )` This function 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.
`Unit`	`startPostponedEnterTransition()` Begin postponed transitions after `postponeEnterTransition` was called.
`String`	`toString()`
`Unit`	`unregisterForContextMenu(view: View)` Prevents a context menu to be shown for the given view.

From androidx.lifecycle.HasDefaultViewModelProviderFactory

`CreationExtras!`	`getDefaultViewModelCreationExtras()`
`abstract ViewModelProvider.Factory!`	`getDefaultViewModelProviderFactory()`

From androidx.lifecycle.LifecycleOwner

abstract Lifecycle!

getLifecycle()

From androidx.savedstate.SavedStateRegistryOwner

abstract SavedStateRegistry!

getSavedStateRegistry()

From android.view.View.OnCreateContextMenuListener

abstract Unit

onCreateContextMenu(
    p: ContextMenu!,
    p1: View!,
    p2: ContextMenu.ContextMenuInfo!
)

From androidx.lifecycle.ViewModelStoreOwner

abstract ViewModelStore!

getViewModelStore()

Constants

EXTRA_BURN_IN_PROTECTION

Added in 1.1.0

Deprecated in 1.3.0

const val EXTRA_BURN_IN_PROTECTION = "com.google.android.wearable.compat.extra.BURN_IN_PROTECTION": String!

Property in bundle passed to AmbientCallback#onEnterAmbient(Bundle) to indicate whether burn-in protection is required. When this property is set to true, views must be shifted around periodically in ambient mode. To ensure that content isn't shifted off the screen, avoid placing content within 10 pixels of the edge of the screen. Activities should also avoid solid white areas to prevent pixel burn-in. Both of these requirements only apply in ambient mode, and only when this property is set to true.

EXTRA_LOWBIT_AMBIENT

Added in 1.1.0

Deprecated in 1.3.0

const val EXTRA_LOWBIT_AMBIENT = "com.google.android.wearable.compat.extra.LOWBIT_AMBIENT": String!

Property in bundle passed to AmbientCallback#onEnterAmbient(Bundle) to indicate whether the device has low-bit ambient mode. When this property is set to true, the screen supports fewer bits for each color in ambient mode. In this case, activities should disable anti-aliasing in ambient mode.

FRAGMENT_TAG

Added in 1.1.0

Deprecated in 1.3.0

const val FRAGMENT_TAG = "android.support.wearable.ambient.AmbientMode": String!

Fragment tag used by default when adding AmbientModeSupport to add ambient support to a FragmentActivity.

Public constructors

AmbientModeSupport

Added in 1.1.0

Deprecated in 1.3.0

AmbientModeSupport()

Constructor

Public functions

attach

Added in 1.1.0

Deprecated in 1.3.0

java-static fun <T : FragmentActivity?> attach(activity: T!): AmbientModeSupport.AmbientController!

Attach ambient support to the given activity. Calling this method with an Activity implementing the AmbientCallbackProvider interface will provide you with an opportunity to react to ambient events such as onEnterAmbient. Alternatively, you can call this method with an Activity which does not implement the AmbientCallbackProvider interface and that will only enable the auto-resume functionality. This is equivalent to providing (@code null} from the AmbientCallbackProvider.

Parameters
`activity: T!`	the activity to attach ambient support to.

Returns
`AmbientModeSupport.AmbientController!`	the associated `AmbientController` which can be used to query the state of ambient mode.

dump

fun dump(
    prefix: String!,
    fd: FileDescriptor!,
    writer: PrintWriter!,
    args: Array<String!>!
): Unit

Print the Fragments's state into the given stream.

Parameters
`prefix: String!`	Text to print at the front of each line.
`fd: FileDescriptor!`	The raw file descriptor that the dump is being sent to.
`writer: PrintWriter!`	The PrintWriter to which you should dump your state. This will be closed for you after you return.
`args: Array<String!>!`	additional arguments to the dump request.

onAttach

@CallSuper
fun onAttach(context: Context!): Unit

Called when a fragment is first attached to its context. onCreate will be called after this.

onCreate

@CallSuper
fun onCreate(savedInstanceState: Bundle!): Unit

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
`savedInstanceState: Bundle!`	If the fragment is being re-created from a previous saved state, this is the state.

onDestroy

@CallSuper
fun onDestroy(): Unit

Called when the fragment is no longer in use. This is called after onStop and before onDetach.

onDetach

@CallSuper
fun onDetach(): Unit

Called when the fragment is no longer attached to its activity. This is called after onDestroy.

onPause

@CallSuper
fun onPause(): Unit

Called when the Fragment is no longer resumed. This is generally tied to Activity.onPause of the containing Activity's lifecycle.

onResume

@CallSuper
fun onResume(): Unit

Called when the fragment is visible to the user and actively running. This is generally tied to Activity.onResume of the containing Activity's lifecycle.

onStop

@CallSuper
fun onStop(): Unit

Called when the Fragment is no longer started. This is generally tied to Activity.onStop of the containing Activity's lifecycle.

AmbientModeSupport

Summary

Nested types

Constants

Public constructors

Public functions

Inherited functions

Constants

EXTRA_BURN_IN_PROTECTION

EXTRA_LOWBIT_AMBIENT

FRAGMENT_TAG

Public constructors

AmbientModeSupport

Public functions

attach

dump

onAttach

onCreate

onDestroy

onDetach

onPause

onResume

onStop