urbanairship-message-center/com.urbanairship.messagecenter.ui/MessageListFragment

MessageListFragment

open class MessageListFragment @JvmOverloads constructor(@LayoutRes contentLayoutId: Int = R.layout.ua_fragment_message_list) : Fragment(source)

Fragment that displays the Message Center list and message view.

Inheritors

MessageCenterListFragment

Constructors

MessageListFragment

@JvmOverloads

constructor(@LayoutRes contentLayoutId: Int = R.layout.ua_fragment_message_list)

Types

OnEditListener

interface OnEditListener

Listener interface for MessageListFragment edit mode and editing changes.

OnMessageClickListener

fun interface OnMessageClickListener

Listener interface for MessageListFragment message selection.

Properties

isEditing

var isEditing: Boolean

Flag that controls whether the list is in editing mode.

messageListView

protected var messageListView: MessageListView?

The MessageListView, or null if the view has not yet been inflated.

onEditListener

var onEditListener: MessageListFragment.OnEditListener?

Listener for edit mode changes.

onMessageClickListener

var onMessageClickListener: MessageListFragment.OnMessageClickListener?

Listener for message selection.

predicate

var predicate: Predicate<Message>?

Optional Predicate to filter messages.

viewModel

protected val viewModel: MessageListViewModel

The message list ViewModel.

Inherited properties

activity

@get:Nullable

val activity: FragmentActivity?

allowEnterTransitionOverlap

open var allowEnterTransitionOverlap: Boolean

allowReturnTransitionOverlap

open var allowReturnTransitionOverlap: Boolean

arguments

@get:Nullable

var arguments: Bundle?

childFragmentManager

@get:NonNull

val childFragmentManager: FragmentManager

context

@get:Nullable

open val context: Context?

defaultViewModelCreationExtras

@get:NonNull

@get:CallSuper

open val defaultViewModelCreationExtras: CreationExtras

defaultViewModelProviderFactory

@get:NonNull

open val defaultViewModelProviderFactory: ViewModelProvider.Factory

enterTransition

@get:Nullable

open var enterTransition: Any?

exitTransition

@get:Nullable

open var exitTransition: Any?

fragmentManager

@get:Nullable

val fragmentManager: FragmentManager?

host

@get:Nullable

val host: Any?

val id: Int

isAdded

val isAdded: Boolean

isDetached

val isDetached: Boolean

isHidden

val isHidden: Boolean

isInLayout

val isInLayout: Boolean

isMenuVisible

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

val isMenuVisible: Boolean

isRemoving

val isRemoving: Boolean

isResumed

val isResumed: Boolean

isStateSaved

val isStateSaved: Boolean

isVisible

val isVisible: Boolean

layoutInflater

@get:NonNull

val layoutInflater: LayoutInflater

lifecycle

@get:NonNull

open val lifecycle: Lifecycle

loaderManager

@get:NonNull

open val loaderManager: LoaderManager

mPreviousWho

@RestrictTo(value = [RestrictTo.Scope.LIBRARY])

@Nullable

var mPreviousWho: String?

parentFragment

@get:Nullable

val parentFragment: Fragment?

parentFragmentManager

@get:NonNull

val parentFragmentManager: FragmentManager

reenterTransition

@get:Nullable

open var reenterTransition: Any?

resources

@get:NonNull

val resources: Resources

retainInstance

var retainInstance: Boolean

returnTransition

@get:Nullable

open var returnTransition: Any?

savedStateRegistry

@get:NonNull

val savedStateRegistry: SavedStateRegistry

sharedElementEnterTransition

@get:Nullable

open var sharedElementEnterTransition: Any?

sharedElementReturnTransition

@get:Nullable

open var sharedElementReturnTransition: Any?

tag

@get:Nullable

val tag: String?

targetFragment

@get:Nullable

val targetFragment: Fragment?

targetRequestCode

val targetRequestCode: Int

userVisibleHint

open var userVisibleHint: Boolean

view

@get:Nullable

open val view: View?

viewLifecycleOwner

@get:MainThread

@get:NonNull

open val viewLifecycleOwner: LifecycleOwner

viewLifecycleOwnerLiveData

@get:NonNull

open val viewLifecycleOwnerLiveData: LiveData<LifecycleOwner?>

viewModelStore

@get:NonNull

open val viewModelStore: ViewModelStore

Functions

clearHighlighted

fun clearHighlighted()

Clears the highlighted message.

deleteAllMessages

fun deleteAllMessages()

Deletes all messages in the list.

markAllMessagesRead

fun markAllMessagesRead()

Marks all messages in the list as read.

onEditModeChanged

protected open fun onEditModeChanged(isEditing: Boolean)

May be overridden in subclasses to handle edit mode changes.

onViewCreated

@CallSuper

open override fun onViewCreated(view: View, savedInstanceState: Bundle?)

refresh

fun refresh(onRefreshed: () -> Unit = {})

Refreshes the message list, with an optional onRefreshed callback.

setHighlighted

fun setHighlighted(messageId: String)

Sets the highlighted message.

Inherited functions

dump

open fun dump(@NonNull prefix: String, @Nullable fd: FileDescriptor?, @NonNull writer: PrintWriter, @Nullable args: Array<out String?>??)

getString

@NonNull

fun getString(@StringRes resId: Int): String

@NonNull

fun getString(@StringRes resId: Int, @Nullable vararg formatArgs: Any?): String

getText

@NonNull

fun getText(@StringRes resId: Int): CharSequence

hasOptionsMenu

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

fun hasOptionsMenu(): Boolean

onActivityCreated

@MainThread

@CallSuper

open fun ~~onActivityCreated~~(@Nullable savedInstanceState: Bundle?)

onActivityResult

open fun ~~onActivityResult~~(requestCode: Int, resultCode: Int, @Nullable data: Intent?)

onAttach

@MainThread

@CallSuper

open fun ~~onAttach~~(@NonNull activity: Activity)

@MainThread

@CallSuper

open fun onAttach(@NonNull context: Context)

onAttachFragment

@MainThread

open fun ~~onAttachFragment~~(@NonNull childFragment: Fragment)

onConfigurationChanged

@CallSuper

open fun onConfigurationChanged(@NonNull newConfig: Configuration)

onContextItemSelected

@MainThread

open fun onContextItemSelected(@NonNull item: MenuItem): Boolean

onCreate

@MainThread

@CallSuper

open fun onCreate(@Nullable savedInstanceState: Bundle?)

onCreateAnimation

@MainThread

@Nullable

open fun onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int): Animation?

onCreateAnimator

@MainThread

@Nullable

open fun onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int): Animator?

onCreateContextMenu

@MainThread

open fun onCreateContextMenu(@NonNull menu: ContextMenu, @NonNull v: View, @Nullable menuInfo: ContextMenu.ContextMenuInfo?)

onCreateOptionsMenu

@MainThread

open fun ~~onCreateOptionsMenu~~(@NonNull menu: Menu, @NonNull inflater: MenuInflater)

onCreateView

@MainThread

@Nullable

open fun onCreateView(@NonNull inflater: LayoutInflater, @Nullable container: ViewGroup?, @Nullable savedInstanceState: Bundle?): View?

open fun onDestroy()

open fun ~~onDestroyOptionsMenu~~()

onDestroyView

@MainThread

@CallSuper

open fun onDestroyView()

open fun onDetach()

open fun onGetLayoutInflater(@Nullable savedInstanceState: Bundle?): LayoutInflater

onHiddenChanged

@MainThread

open fun onHiddenChanged(hidden: Boolean)

onInflate

@UiThread

@CallSuper

open fun ~~onInflate~~(@NonNull activity: Activity, @NonNull attrs: AttributeSet, @Nullable savedInstanceState: Bundle?)

@UiThread

@CallSuper

open fun onInflate(@NonNull context: Context, @NonNull attrs: AttributeSet, @Nullable savedInstanceState: Bundle?)

onLowMemory

@MainThread

@CallSuper

open fun onLowMemory()

onMultiWindowModeChanged

open fun onMultiWindowModeChanged(isInMultiWindowMode: Boolean)

onOptionsItemSelected

@MainThread

open fun ~~onOptionsItemSelected~~(@NonNull item: MenuItem): Boolean

onOptionsMenuClosed

@MainThread

open fun ~~onOptionsMenuClosed~~(@NonNull menu: Menu)

onPause

@MainThread

@CallSuper

open fun onPause()

onPictureInPictureModeChanged

open fun onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)

onPrepareOptionsMenu

@MainThread

open fun ~~onPrepareOptionsMenu~~(@NonNull menu: Menu)

onPrimaryNavigationFragmentChanged

@MainThread

open fun onPrimaryNavigationFragmentChanged(isPrimaryNavigationFragment: Boolean)

onRequestPermissionsResult

open fun ~~onRequestPermissionsResult~~(requestCode: Int, @NonNull permissions: Array<out String?>, @NonNull grantResults: IntArray)

open fun onResume()

open fun onSaveInstanceState(@NonNull outState: Bundle)

open fun onStart()

open fun onStop()

open fun onViewStateRestored(@Nullable savedInstanceState: Bundle?)

postponeEnterTransition

open fun postponeEnterTransition()

fun postponeEnterTransition(duration: Long, @NonNull timeUnit: TimeUnit)

registerForActivityResult

@MainThread

@NonNull

fun <I : Any?, O : Any?> registerForActivityResult(@NonNull contract: ActivityResultContract<I, O>, @NonNull callback: ActivityResultCallback<O>): ActivityResultLauncher<I?>

@MainThread

@NonNull

fun <I : Any?, O : Any?> registerForActivityResult(@NonNull contract: ActivityResultContract<I, O>, @NonNull registry: ActivityResultRegistry, @NonNull callback: ActivityResultCallback<O>): ActivityResultLauncher<I?>

registerForContextMenu

open fun registerForContextMenu(@NonNull view: View)

requestPermissions

fun ~~requestPermissions~~(@NonNull permissions: Array<out String?>, requestCode: Int)

requireActivity

@NonNull

fun requireActivity(): FragmentActivity

requireArguments

@NonNull

fun requireArguments(): Bundle

requireContext

@NonNull

fun requireContext(): Context

requireFragmentManager

@NonNull

fun ~~requireFragmentManager~~(): FragmentManager

requireHost

@NonNull

fun requireHost(): Any

requireParentFragment

@NonNull

fun requireParentFragment(): Fragment

requireView

@NonNull

fun requireView(): View

setEnterSharedElementCallback

open fun setEnterSharedElementCallback(@Nullable callback: SharedElementCallback?)

setExitSharedElementCallback

open fun setExitSharedElementCallback(@Nullable callback: SharedElementCallback?)

setHasOptionsMenu

open fun ~~setHasOptionsMenu~~(hasMenu: Boolean)

setInitialSavedState

open fun setInitialSavedState(@Nullable state: Fragment.SavedState?)

setMenuVisibility

open fun setMenuVisibility(menuVisible: Boolean)

setTargetFragment

open fun ~~setTargetFragment~~(@Nullable fragment: Fragment?, requestCode: Int)

shouldShowRequestPermissionRationale

open fun shouldShowRequestPermissionRationale(@NonNull permission: String): Boolean

startActivity

open fun startActivity(@NonNull intent: Intent)

open fun startActivity(@NonNull intent: Intent, @Nullable options: Bundle?)

startActivityForResult

open fun ~~startActivityForResult~~(@NonNull intent: Intent, requestCode: Int)

open fun ~~startActivityForResult~~(@NonNull intent: Intent, requestCode: Int, @Nullable options: Bundle?)

startIntentSenderForResult

open fun ~~startIntentSenderForResult~~(@NonNull intent: IntentSender, requestCode: Int, @Nullable fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, @Nullable options: Bundle?)

startPostponedEnterTransition

open fun startPostponedEnterTransition()

unregisterForContextMenu

open fun unregisterForContextMenu(@NonNull view: View)