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

MessageFragment

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

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

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

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 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)

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 onStart()

open fun onStop()

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)