AmbientModeSupport

Added in 1.1.0

Deprecated in 1.3.0

Kotlin |Java

public final class AmbientModeSupport extends Fragment

java.lang.Object
↳	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
`public abstract class AmbientModeSupport.AmbientCallback` Callback to receive ambient mode state changes.
`public interface AmbientModeSupport.AmbientCallbackProvider` Interface for any `Activity` that wishes to implement Ambient Mode.
`public final inner class AmbientModeSupport.AmbientController` A class for interacting with the ambient mode on a wearable device.

Constants
`static final 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.
`static final 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.
`static final 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 methods
`static AmbientModeSupport.AmbientController`	`<T extends FragmentActivity> attach(T activity)` Attach ambient support to the given activity.
`void`	`dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)` Print the Fragments's state into the given stream.
`void`	`@CallSuper onAttach(Context context)` Called when a fragment is first attached to its context.
`void`	`@CallSuper onCreate(Bundle savedInstanceState)` Called to do initial creation of a fragment.
`void`	`@CallSuper onDestroy()` Called when the fragment is no longer in use.
`void`	`@CallSuper onDetach()` Called when the fragment is no longer attached to its activity.
`void`	`@CallSuper onPause()` Called when the Fragment is no longer resumed.
`void`	`@CallSuper onResume()` Called when the fragment is visible to the user and actively running.
`void`	`@CallSuper onStop()` Called when the Fragment is no longer started.

Inherited methods

From androidx.activity.result.ActivityResultCaller

abstract ActivityResultLauncher<I>

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

From android.content.ComponentCallbacks

`abstract void`	`onConfigurationChanged(Configuration p)`
`abstract void`	`onLowMemory()` This method is deprecated.

From androidx.fragment.app.Fragment

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

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

From androidx.lifecycle.ViewModelStoreOwner

abstract ViewModelStore

getViewModelStore()

Constants

EXTRA_BURN_IN_PROTECTION

Added in 1.1.0

Deprecated in 1.3.0

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

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

public static final 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

Added in 1.1.0

Deprecated in 1.3.0

public AmbientModeSupport()

Constructor

Public methods

attach

Added in 1.1.0

Deprecated in 1.3.0

public static AmbientModeSupport.AmbientController <T extends FragmentActivity> attach(T activity)

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
`T activity`	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

public void dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)

Print the Fragments's state into the given stream.

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

onAttach

@CallSuper
public void onAttach(Context context)

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

onCreate

@CallSuper
public void onCreate(Bundle savedInstanceState)

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

onDestroy

@CallSuper
public void onDestroy()

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

onDetach

@CallSuper
public void onDetach()

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

onPause

@CallSuper
public void onPause()

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

onResume

@CallSuper
public void onResume()

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
public void onStop()

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 methods

Inherited methods

Constants

EXTRA_BURN_IN_PROTECTION

EXTRA_LOWBIT_AMBIENT

FRAGMENT_TAG

Public constructors

AmbientModeSupport

Public methods

attach

dump

onAttach

onCreate

onDestroy

onDetach

onPause

onResume

onStop