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

MessageFragment

open class MessageFragment @JvmOverloads constructor(@LayoutRes contentLayoutId: Int = R.layout.ua_fragment_message) : Fragment

Fragment that displays a Message Center Message.

Inheritors

MessageCenterMessageFragment

Constructors

MessageFragment

@JvmOverloads

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

Types

Companion

object Companion

Listener

interface Listener

Listener interface for MessageFragment.

Properties

currentMessage

val currentMessage: Message?

The currently displayed message, if a message is loaded.

listener

var listener: MessageFragment.Listener?

Listener for MessageFragment events.

messageId

val messageId: String?

The current Message ID.

messageView

protected var messageView: MessageView?

The MessageView to display the message.

showEmptyView

var showEmptyView: Boolean

Controls whether the "No message selected" view is shown when no message is loaded.

viewModel

protected val viewModel: MessageViewModel

The message ViewModel.

Inherited properties

defaultViewModelCreationExtras

@get:NonNull

@get:CallSuper

open override val defaultViewModelCreationExtras: CreationExtras

defaultViewModelProviderFactory

@get:NonNull

open override val defaultViewModelProviderFactory: ViewModelProvider.Factory

lifecycle

@get:NonNull

open override val lifecycle: Lifecycle

mPreviousWho

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

@Nullable

var mPreviousWho: String?

savedStateRegistry

@get:NonNull

override val savedStateRegistry: SavedStateRegistry

viewModelStore

@get:NonNull

open override val viewModelStore: ViewModelStore

Functions

clearMessage

fun clearMessage()

Clears the currently displayed message.

deleteMessage

fun deleteMessage(message: Message)

Deletes the given message.

loadMessage

fun loadMessage(messageId: String)

Loads the message with the given messageId.

onCloseMessage

protected open fun onCloseMessage()

Called when a message requests to be closed.

onMessageLoaded

protected open fun onMessageLoaded(message: Message)

Called when a message is loaded.

onMessageLoadError

protected open fun onMessageLoadError(error: MessageViewState.Error.Type)

Called when a message load fails.

onPause

open override fun onPause()

onResume

open override fun onResume()

onSaveInstanceState

open override fun onSaveInstanceState(outState: Bundle)

onViewCreated

@CallSuper

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

onViewStateRestored

open override fun onViewStateRestored(savedInstanceState: Bundle?)

Inherited functions

dump

open fun dump(@NonNull p0: String, @Nullable p1: FileDescriptor?, @NonNull p2: PrintWriter, @Nullable p3: Array<String>?)

equals

operator override fun equals(@Nullable other: Any?): Boolean

getActivity

@Nullable

fun getActivity(): FragmentActivity?

getAllowEnterTransitionOverlap

open fun getAllowEnterTransitionOverlap(): Boolean

getAllowReturnTransitionOverlap

open fun getAllowReturnTransitionOverlap(): Boolean

getArguments

@Nullable

fun getArguments(): Bundle?

getChildFragmentManager

@NonNull

fun getChildFragmentManager(): FragmentManager

getContext

@Nullable

open fun getContext(): Context?

getEnterTransition

@Nullable

open fun getEnterTransition(): Any?

getExitTransition

@Nullable

open fun getExitTransition(): Any?

getFragmentManager

@Nullable

fun ~~getFragmentManager~~(): FragmentManager?

fun getHost(): Any?

fun getId(): Int

fun getLayoutInflater(): LayoutInflater

@NonNull

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

open fun ~~getLayoutInflater~~(@Nullable p0: Bundle?): LayoutInflater

getLoaderManager

@NonNull

open fun ~~getLoaderManager~~(): LoaderManager

getParentFragment

@Nullable

fun getParentFragment(): Fragment?

getParentFragmentManager

@NonNull

fun getParentFragmentManager(): FragmentManager

getReenterTransition

@Nullable

open fun getReenterTransition(): Any?

getResources

@NonNull

fun getResources(): Resources

getRetainInstance

fun ~~getRetainInstance~~(): Boolean

getReturnTransition

@Nullable

open fun getReturnTransition(): Any?

getSharedElementEnterTransition

@Nullable

open fun getSharedElementEnterTransition(): Any?

getSharedElementReturnTransition

@Nullable

open fun getSharedElementReturnTransition(): Any?

getString

@NonNull

fun getString(@StringRes p0: Int): String

@NonNull

fun getString(@StringRes p0: Int, @Nullable vararg p1: Any): String

getTag

@Nullable

fun getTag(): String?

getTargetFragment

@Nullable

fun ~~getTargetFragment~~(): Fragment?

getTargetRequestCode

fun ~~getTargetRequestCode~~(): Int

getText

@NonNull

fun getText(@StringRes p0: Int): CharSequence

getUserVisibleHint

open fun ~~getUserVisibleHint~~(): Boolean

getView

@Nullable

open fun getView(): View?

getViewLifecycleOwner

@MainThread

@NonNull

open fun getViewLifecycleOwner(): LifecycleOwner

getViewLifecycleOwnerLiveData

@NonNull

open fun getViewLifecycleOwnerLiveData(): LiveData<LifecycleOwner>

hashCode

override fun hashCode(): Int

hasOptionsMenu

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

fun hasOptionsMenu(): Boolean

isAdded

fun isAdded(): Boolean

isDetached

fun isDetached(): Boolean

isHidden

fun isHidden(): Boolean

isInLayout

fun isInLayout(): Boolean

isMenuVisible

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

fun isMenuVisible(): Boolean

isRemoving

fun isRemoving(): Boolean

isResumed

fun isResumed(): Boolean

isStateSaved

fun isStateSaved(): Boolean

isVisible

fun isVisible(): Boolean

onActivityCreated

@MainThread

@CallSuper

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

onActivityResult

open fun ~~onActivityResult~~(p0: Int, p1: Int, @Nullable p2: Intent?)

onAttach

@MainThread

@CallSuper

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

@MainThread

@CallSuper

open fun onAttach(@NonNull p0: Context)

onAttachFragment

@MainThread

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

onConfigurationChanged

@CallSuper

open override fun onConfigurationChanged(@NonNull p0: Configuration)

onContextItemSelected

@MainThread

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

onCreate

@MainThread

@CallSuper

open fun onCreate(@Nullable p0: Bundle?)

onCreateAnimation

@MainThread

@Nullable

open fun onCreateAnimation(p0: Int, p1: Boolean, p2: Int): Animation?

onCreateAnimator

@MainThread

@Nullable

open fun onCreateAnimator(p0: Int, p1: Boolean, p2: Int): Animator?

onCreateContextMenu

@MainThread

open override fun onCreateContextMenu(@NonNull p0: ContextMenu, @NonNull p1: View, @Nullable p2: ContextMenu.ContextMenuInfo?)

onCreateOptionsMenu

@MainThread

open fun ~~onCreateOptionsMenu~~(@NonNull p0: Menu, @NonNull p1: MenuInflater)

onCreateView

@MainThread

@Nullable

open fun onCreateView(@NonNull p0: LayoutInflater, @Nullable p1: ViewGroup?, @Nullable p2: Bundle?): View?

open fun onDestroy()

open fun ~~onDestroyOptionsMenu~~()

onDestroyView

@MainThread

@CallSuper

open fun onDestroyView()

open fun onDetach()

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

onHiddenChanged

@MainThread

open fun onHiddenChanged(p0: Boolean)

onInflate

@UiThread

@CallSuper

open fun ~~onInflate~~(@NonNull p0: Activity, @NonNull p1: AttributeSet, @Nullable p2: Bundle?)

@UiThread

@CallSuper

open fun onInflate(@NonNull p0: Context, @NonNull p1: AttributeSet, @Nullable p2: Bundle?)

onLowMemory

@MainThread

@CallSuper

open override fun onLowMemory()

onMultiWindowModeChanged

open fun onMultiWindowModeChanged(p0: Boolean)

onOptionsItemSelected

@MainThread

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

onOptionsMenuClosed

@MainThread

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

onPictureInPictureModeChanged

open fun onPictureInPictureModeChanged(p0: Boolean)

onPrepareOptionsMenu

@MainThread

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

onPrimaryNavigationFragmentChanged

@MainThread

open fun onPrimaryNavigationFragmentChanged(p0: Boolean)

onRequestPermissionsResult

open fun ~~onRequestPermissionsResult~~(p0: Int, @NonNull p1: Array<String>, @NonNull p2: IntArray)

open fun onStart()

open fun onStop()

postponeEnterTransition

open fun postponeEnterTransition()

fun postponeEnterTransition(p0: Long, @NonNull p1: TimeUnit)

registerForActivityResult

@MainThread

@NonNull

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

@MainThread

@NonNull

override 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 p0: View)

requestPermissions

fun ~~requestPermissions~~(@NonNull p0: Array<String>, p1: 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

setAllowEnterTransitionOverlap

open fun setAllowEnterTransitionOverlap(p0: Boolean)

setAllowReturnTransitionOverlap

open fun setAllowReturnTransitionOverlap(p0: Boolean)

setArguments

open fun setArguments(@Nullable p0: Bundle?)

setEnterSharedElementCallback

open fun setEnterSharedElementCallback(@Nullable p0: SharedElementCallback?)

setEnterTransition

open fun setEnterTransition(@Nullable p0: Any?)

setExitSharedElementCallback

open fun setExitSharedElementCallback(@Nullable p0: SharedElementCallback?)

setExitTransition

open fun setExitTransition(@Nullable p0: Any?)

setHasOptionsMenu

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

setInitialSavedState

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

setMenuVisibility

open fun setMenuVisibility(p0: Boolean)

setReenterTransition

open fun setReenterTransition(@Nullable p0: Any?)

setRetainInstance

open fun ~~setRetainInstance~~(p0: Boolean)

setReturnTransition

open fun setReturnTransition(@Nullable p0: Any?)

setSharedElementEnterTransition

open fun setSharedElementEnterTransition(@Nullable p0: Any?)

setSharedElementReturnTransition

open fun setSharedElementReturnTransition(@Nullable p0: Any?)

setTargetFragment

open fun ~~setTargetFragment~~(@Nullable p0: Fragment?, p1: Int)

setUserVisibleHint

open fun ~~setUserVisibleHint~~(p0: Boolean)

shouldShowRequestPermissionRationale

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

startActivity

open fun startActivity(@NonNull p0: Intent)

open fun startActivity(@NonNull p0: Intent, @Nullable p1: Bundle?)

startActivityForResult

open fun ~~startActivityForResult~~(@NonNull p0: Intent, p1: Int)

open fun ~~startActivityForResult~~(@NonNull p0: Intent, p1: Int, @Nullable p2: Bundle?)

startIntentSenderForResult

open fun ~~startIntentSenderForResult~~(@NonNull p0: IntentSender, p1: Int, @Nullable p2: Intent?, p3: Int, p4: Int, p5: Int, @Nullable p6: Bundle?)

startPostponedEnterTransition

open fun startPostponedEnterTransition()

toString

@NonNull

open override fun toString(): String

unregisterForContextMenu

open fun unregisterForContextMenu(@NonNull p0: View)