Package com.batch.android.messaging.fragment

Class ModalTemplateFragment

java.lang.Object

androidx.fragment.app.Fragment

androidx.fragment.app.DialogFragment

com.batch.android.messaging.fragment.BaseDialogFragment<ModalMessage>

com.batch.android.messaging.fragment.ModalTemplateFragment

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.DialogInterface.OnCancelListener, android.content.DialogInterface.OnDismissListener, android.view.View.OnCreateContextMenuListener, androidx.lifecycle.LifecycleOwner, androidx.lifecycle.ViewModelStoreOwner, ListenableDialog, ModalContentPanGestureDetector.OnDismissListener, BannerView.OnActionListener, ImageHelper.Cache

public class ModalTemplateFragment
extends BaseDialogFragment<ModalMessage>
implements BannerView.OnActionListener, ModalContentPanGestureDetector.OnDismissListener

Universal messaging template fragment class. Extends DialogFragment so it can be displayed in its own window easily.

Nested Class Summary

Nested classes/interfaces inherited from class androidx.fragment.app.Fragment

androidx.fragment.app.Fragment.InstantiationException, androidx.fragment.app.Fragment.SavedState

Field Summary

Fields inherited from class com.batch.android.messaging.fragment.BaseDialogFragment

analyticsDelegate, autoCloseAtUptime, automaticallyBeginAutoClose, imageCache, messagingModule

Fields inherited from class androidx.fragment.app.DialogFragment

STYLE_NO_FRAME, STYLE_NO_INPUT, STYLE_NO_TITLE, STYLE_NORMAL

Constructor Summary

Constructors

Constructor	Description
ModalTemplateFragment()

Method Summary

Modifier and Type	Method	Description
protected boolean	canAutoClose()
void	dismiss()	Deprecated. Use dismissSafely() to prevent crashes
void	dismissAllowingStateLoss()	Deprecated. Use dismissSafely() to prevent crashes
protected void	dismissSafely()
protected int	getAutoCloseDelayMillis()
static ModalTemplateFragment	newInstance(BatchMessage payloadMessage, ModalMessage messageModel)
protected void	onAutoCloseCountdownStarted()
void	onCloseAction()
void	onCreate(android.os.Bundle savedInstanceState)
android.app.Dialog	onCreateDialog(android.os.Bundle savedInstanceState)
android.view.View	onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)
void	onCTAAction(int index, CTA cta)
void	onDestroyView()
void	onDismiss(android.content.DialogInterface dialog)
void	onGlobalAction()
void	onPanDismiss()
void	onStart()
protected void	performAutoClose()

Methods inherited from class com.batch.android.messaging.fragment.BaseDialogFragment

beginAutoCloseCountdown, get, getMessageModel, getPayloadMessage, onCancel, onSaveInstanceState, onStop, put, scheduleAutoCloseTask, setDialogEventListener, setMessageArguments, unscheduleAutoCloseTask

Methods inherited from class androidx.fragment.app.DialogFragment

getDialog, getShowsDialog, getTheme, isCancelable, onActivityCreated, onAttach, onDetach, onGetLayoutInflater, setCancelable, setShowsDialog, setStyle, setupDialog, show, show, showNow

Methods inherited from class androidx.fragment.app.Fragment

dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLifecycle, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewLifecycleOwner, getViewLifecycleOwnerLiveData, getViewModelStore, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isStateSaved, isVisible, onActivityResult, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroy, onDestroyOptionsMenu, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPrepareOptionsMenu, onRequestPermissionsResult, onResume, onViewCreated, onViewStateRestored, postponeEnterTransition, registerForContextMenu, requestPermissions, requireActivity, requireContext, requireFragmentManager, requireHost, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModalTemplateFragment

public ModalTemplateFragment()

Method Detail

newInstance

public static ModalTemplateFragment newInstance(BatchMessage payloadMessage,
                                                ModalMessage messageModel)

onCreate

public void onCreate(@Nullable
                     android.os.Bundle savedInstanceState)

Overrides:

onCreate in class BaseDialogFragment<ModalMessage>

onCreateDialog

public android.app.Dialog onCreateDialog(android.os.Bundle savedInstanceState)

Overrides:

onCreateDialog in class androidx.fragment.app.DialogFragment

onCreateView

@Nullable
public android.view.View onCreateView(android.view.LayoutInflater inflater,
                                      @Nullable
                                      android.view.ViewGroup container,
                                      @Nullable
                                      android.os.Bundle savedInstanceState)

Overrides:

onCreateView in class androidx.fragment.app.Fragment

onStart

public void onStart()

Overrides:

onStart in class BaseDialogFragment<ModalMessage>

onDestroyView

public void onDestroyView()

Overrides:

onDestroyView in class androidx.fragment.app.DialogFragment

onDismiss

public void onDismiss(android.content.DialogInterface dialog)

Specified by:

onDismiss in interface android.content.DialogInterface.OnDismissListener

Overrides:

onDismiss in class BaseDialogFragment<ModalMessage>

dismiss

@Deprecated
public void dismiss()

Deprecated.

Use dismissSafely() to prevent crashes

Dismiss.

Overrides:

dismiss in class androidx.fragment.app.DialogFragment

dismissAllowingStateLoss

@Deprecated
public void dismissAllowingStateLoss()

Deprecated.

Use dismissSafely() to prevent crashes

Dismiss.

Overrides:

dismissAllowingStateLoss in class androidx.fragment.app.DialogFragment

dismissSafely

protected void dismissSafely()

Overrides:

dismissSafely in class BaseDialogFragment<ModalMessage>

onAutoCloseCountdownStarted

protected void onAutoCloseCountdownStarted()

Specified by:

onAutoCloseCountdownStarted in class BaseDialogFragment<ModalMessage>

canAutoClose

protected boolean canAutoClose()

Specified by:

canAutoClose in class BaseDialogFragment<ModalMessage>

getAutoCloseDelayMillis

protected int getAutoCloseDelayMillis()

Specified by:

getAutoCloseDelayMillis in class BaseDialogFragment<ModalMessage>

performAutoClose

protected void performAutoClose()

Specified by:

performAutoClose in class BaseDialogFragment<ModalMessage>

onCloseAction

public void onCloseAction()

Specified by:

onCloseAction in interface BannerView.OnActionListener

onCTAAction

public void onCTAAction(int index,
                        @NonNull
                        CTA cta)

Specified by:

onCTAAction in interface BannerView.OnActionListener

onGlobalAction

public void onGlobalAction()

Specified by:

onGlobalAction in interface BannerView.OnActionListener

onPanDismiss

public void onPanDismiss()

Specified by:

onPanDismiss in interface ModalContentPanGestureDetector.OnDismissListener