Google is committed to advancing racial equity for Black communities. See how.

ContextAwareHelper

class ContextAwareHelper
kotlin.Any
   ↳ androidx.activity.contextaware.ContextAwareHelper

Helper class for implementing ContextAware. Classes using this helper should call addOnContextAvailableListener(OnContextAvailableListener) and removeOnContextAvailableListener(OnContextAvailableListener) as the respective methods of ContextAware are called.

You must call dispatchOnContextAvailable(Context) once the Context is available to dispatch the callbacks to all registered listeners.

Listeners added after the context has been made available via dispatchOnContextAvailable(Context) will have the Context synchronously delivered to them up until clearAvailableContext() is called.

Summary

Public constructors

Construct a new ContextAwareHelper.

Public methods
Unit

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

Unit

Clear any Context previously made available via dispatchOnContextAvailable(Context).

Unit

Dispatch the callback of OnContextAvailableListener#onContextAvailable to all currently added listeners in the order they were added.

Context?

Get the Context if it is currently available.

Unit

Remove a OnContextAvailableListener previously added via addOnContextAvailableListener(OnContextAvailableListener).

Public constructors

<init>

ContextAwareHelper()

Construct a new ContextAwareHelper.

Public methods

addOnContextAvailableListener

fun addOnContextAvailableListener(@NonNull listener: OnContextAvailableListener): Unit

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

Parameters
listener OnContextAvailableListener: The listener that should be added.

clearAvailableContext

fun clearAvailableContext(): Unit

Clear any Context previously made available via dispatchOnContextAvailable(Context).

dispatchOnContextAvailable

fun dispatchOnContextAvailable(@NonNull context: Context): Unit

Dispatch the callback of OnContextAvailableListener#onContextAvailable to all currently added listeners in the order they were added.

Parameters
context Context: The Context the ContextAware object is now associated with.

peekAvailableContext

@Nullable fun peekAvailableContext(): Context?

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

Return
Context? the Context if it is currently available.

removeOnContextAvailableListener

fun removeOnContextAvailableListener(@NonNull listener: OnContextAvailableListener): Unit

Remove a OnContextAvailableListener previously added via addOnContextAvailableListener(OnContextAvailableListener).

Parameters
listener OnContextAvailableListener: The listener that should be removed.