braze-android-sdk/com.braze.ui.contentcards/ContentCardsFragment

ContentCardsFragment

open class ContentCardsFragment : Fragment, SwipeRefreshLayout.OnRefreshListener

A fragment to display Braze ContentCards.

Constructors

ContentCardsFragment

constructor()

Types

object Companion

Properties

val activity: FragmentActivity?

allowEnterTransitionOverlap

open var allowEnterTransitionOverlap: Boolean

allowReturnTransitionOverlap

open var allowReturnTransitionOverlap: Boolean

open val animatingAway: View?

var arguments: Bundle?

var cardAdapter: ContentCardAdapter?

childFragmentManager

val childFragmentManager: FragmentManager

contentCardsRecyclerView

var contentCardsRecyclerView: RecyclerView?

A RecyclerView associated with ContentCardsFragment. Note that this will be null until Fragment.onCreateView is called.

contentCardsSwipeLayout

protected var contentCardsSwipeLayout: SwipeRefreshLayout?

contentCardsUpdatedSubscriber

protected var contentCardsUpdatedSubscriber: IEventSubscriber<ContentCardsUpdatedEvent>?

open val context: Context?

customContentCardsViewBindingHandler

protected var customContentCardsViewBindingHandler: IContentCardsViewBindingHandler?

customContentCardUpdateHandler

protected var customContentCardUpdateHandler: IContentCardsUpdateHandler?

defaultContentCardsViewBindingHandler

protected val defaultContentCardsViewBindingHandler: IContentCardsViewBindingHandler

defaultContentCardUpdateHandler

protected val defaultContentCardUpdateHandler: IContentCardsUpdateHandler

defaultEmptyContentCardsAdapter

protected var defaultEmptyContentCardsAdapter: EmptyContentCardsAdapter

defaultViewModelCreationExtras

open val defaultViewModelCreationExtras: CreationExtras

defaultViewModelProviderFactory

open val defaultViewModelProviderFactory: ViewModelProvider.Factory

emptyCardsAdapter

protected val emptyCardsAdapter: RecyclerView.Adapter<*>

An adapter to display when no cards are available for display.

open val enterAnim: Int

enterTransition

open var enterTransition: Any?

enterTransitionCallback

open val enterTransitionCallback: SharedElementCallback?

open val exitAnim: Int

open var exitTransition: Any?

exitTransitionCallback

open val exitTransitionCallback: SharedElementCallback?

open var focusedView: View?

fragmentManager

val fragmentManager: FragmentManager?

val host: Any?

val id: Int

val isAdded: Boolean

val isDetached: Boolean

val isHidden: Boolean

val isInBackStack: Boolean

val isInLayout: Boolean

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

val isMenuVisible: Boolean

open val isPostponed: Boolean

val isRemoving: Boolean

val isResumed: Boolean

val isStateSaved: Boolean

val isVisible: Boolean

val layoutInflater: LayoutInflater

open val lifecycle: Lifecycle

open val loaderManager: LoaderManager

var mAdded: Boolean

var mAnimationInfo: Fragment.AnimationInfo?

var mArguments: Bundle?

mBackStackNesting

var mBackStackNesting: Int

var mBeingSaved: Boolean

private var mCalled: Boolean

mChildFragmentManager

var mChildFragmentManager: FragmentManager

var mContainer: ViewGroup?

var mContainerId: Int

mContentLayoutId

private var mContentLayoutId: Int

mDefaultFactory

var mDefaultFactory: ViewModelProvider.Factory?

var mDeferStart: Boolean

var mDetached: Boolean

var mFragmentId: Int

mFragmentManager

var mFragmentManager: FragmentManager?

var mFromLayout: Boolean

var mHasMenu: Boolean

var mHidden: Boolean

var mHiddenChanged: Boolean

var mHost: FragmentHostCallback<*>?

mInDynamicContainer

var mInDynamicContainer: Boolean

minimumMaxLifecycleState

private open val minimumMaxLifecycleState: Int

var mInLayout: Boolean

var mIsCreated: Boolean

mIsPrimaryNavigationFragment

private var mIsPrimaryNavigationFragment: Boolean?

mLayoutInflater

var mLayoutInflater: LayoutInflater?

mLifecycleRegistry

var mLifecycleRegistry: LifecycleRegistry?

var mMaxState: Lifecycle.State?

var mMenuVisible: Boolean

mNextLocalRequestCode

private val mNextLocalRequestCode: AtomicInteger?

mOnPreAttachedListeners

private val mOnPreAttachedListeners: ArrayList<Fragment.OnPreAttachedListener?>?

mParentFragment

var mParentFragment: Fragment?

mPerformedCreateView

var mPerformedCreateView: Boolean

mPostponedDurationRunnable

var mPostponedDurationRunnable: Runnable?

mPostponedHandler

var mPostponedHandler: Handler?

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

var mPreviousWho: String?

var mRemoving: Boolean

var mRestored: Boolean

mRetainInstance

var mRetainInstance: Boolean

mRetainInstanceChangedWhileDetached

var mRetainInstanceChangedWhileDetached: Boolean

mSavedFragmentState

var mSavedFragmentState: Bundle?

mSavedStateAttachListener

private val mSavedStateAttachListener: Fragment.OnPreAttachedListener?

mSavedStateRegistryController

var mSavedStateRegistryController: SavedStateRegistryController?

mSavedUserVisibleHint

var mSavedUserVisibleHint: Boolean?

mSavedViewRegistryState

var mSavedViewRegistryState: Bundle?

mSavedViewState

var mSavedViewState: SparseArray<Parcelable?>?

var mState: Int

var mTag: String?

var mTarget: Fragment?

mTargetRequestCode

var mTargetRequestCode: Int

var mTargetWho: String?

var mTransitioning: Boolean

mUserVisibleHint

var mUserVisibleHint: Boolean

var mView: View?

mViewLifecycleOwner

var mViewLifecycleOwner: FragmentViewLifecycleOwner?

mViewLifecycleOwnerLiveData

var mViewLifecycleOwnerLiveData: MutableLiveData<LifecycleOwner?>?

var mWho: String

networkUnavailableJob

protected var networkUnavailableJob: Job?

A runnable to execute when the network is determined to be unavailable.

open var nextTransition: Int

val parentFragment: Fragment?

parentFragmentManager

val parentFragmentManager: FragmentManager

open var popDirection: Boolean

open val popEnterAnim: Int

open val popExitAnim: Int

postOnViewCreatedAlpha

open var postOnViewCreatedAlpha: Float

reenterTransition

open var reenterTransition: Any?

val resources: Resources

var retainInstance: Boolean

returnTransition

open var returnTransition: Any?

savedStateRegistry

val savedStateRegistry: SavedStateRegistry

sdkDataWipeEventSubscriber

protected var sdkDataWipeEventSubscriber: IEventSubscriber<SdkDataWipeEvent>?

sharedElementEnterTransition

open var sharedElementEnterTransition: Any?

sharedElementReturnTransition

open var sharedElementReturnTransition: Any?

sharedElementSourceNames

open val sharedElementSourceNames: ArrayList<String?>

sharedElementTargetNames

open val sharedElementTargetNames: ArrayList<String?>

val tag: String?

val targetFragment: Fragment?

targetRequestCode

val targetRequestCode: Int

userVisibleHint

open var userVisibleHint: Boolean

open val view: View?

viewLifecycleOwner

@get:MainThread

open val viewLifecycleOwner: LifecycleOwner

viewLifecycleOwnerLiveData

open val viewLifecycleOwnerLiveData: LiveData<LifecycleOwner?>

open val viewModelStore: ViewModelStore

Functions

attachSwipeHelperCallback

protected fun attachSwipeHelperCallback()

Creates and attaches a SimpleItemTouchHelperCallback to handle swipe-to-dismiss functionality.

callStartTransitionListener

open fun callStartTransitionListener(calledDirectly: Boolean)

contentCardsUpdate

protected suspend fun contentCardsUpdate(event: ContentCardsUpdatedEvent)

A main thread runnable to handle ContentCardsUpdatedEvent on the main thread.

createFragmentContainer

open fun createFragmentContainer(): FragmentContainer

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

ensureAnimationInfo

private open fun ensureAnimationInfo(): Fragment.AnimationInfo?

findFragmentByWho

open fun findFragmentByWho(@NonNull who: String): Fragment?

generateActivityResultKey

open fun generateActivityResultKey(): String

getContentCardsViewBindingHandler

fun getContentCardsViewBindingHandler(): IContentCardsViewBindingHandler

getContentCardUpdateHandler

fun getContentCardUpdateHandler(): IContentCardsUpdateHandler

fun getString(@StringRes resId: Int): String

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

fun getText(@StringRes resId: Int): CharSequence

handleContentCardsUpdatedEvent

protected fun handleContentCardsUpdatedEvent(event: ContentCardsUpdatedEvent)

Handles the processing and rendering for a ContentCardsUpdatedEvent on the UI thread.

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

fun hasOptionsMenu(): Boolean

initializeRecyclerView

protected fun initializeRecyclerView()

private open fun initLifecycle()

open fun initState()

networkUnavailable

protected suspend fun networkUnavailable()

Called on the main thread when Content Cards cannot be refreshed because the network is unavailable. Logs the event, swaps in the empty cards adapter, and stops the refresh indicator. Integrators that want to surface a custom network-error UI (for example a Toast or Snackbar) should do so at the app layer using their own connectivity signals.

noteStateNotSaved

open fun noteStateNotSaved()

onActivityCreated

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

onActivityResult

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

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

open fun onAttach(@NonNull context: Context)

onAttachFragment

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

onConfigurationChanged

open fun onConfigurationChanged(@NonNull newConfig: Configuration)

onContextItemSelected

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

open fun onCreate(@Nullable savedInstanceState: Bundle?)

onCreateAnimation

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

onCreateAnimator

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

onCreateContextMenu

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

onCreateOptionsMenu

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

open override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View?

open fun onDestroy()

onDestroyOptionsMenu

open fun ~~onDestroyOptionsMenu~~()

open fun onDestroyView()

open fun onDetach()

onGetLayoutInflater

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

onHiddenChanged

open fun onHiddenChanged(hidden: Boolean)

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

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

open fun onLowMemory()

onMultiWindowModeChanged

open fun onMultiWindowModeChanged(isInMultiWindowMode: Boolean)

onOptionsItemSelected

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

onOptionsMenuClosed

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

open override fun onPause()

onPictureInPictureModeChanged

open fun onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)

onPrepareOptionsMenu

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

onPrimaryNavigationFragmentChanged

open fun onPrimaryNavigationFragmentChanged(isPrimaryNavigationFragment: Boolean)

open override fun onRefresh()

Called when the user swipes down and requests a feed refresh.

onRequestPermissionsResult

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

open override fun onResume()

onSaveInstanceState

open override fun onSaveInstanceState(outState: Bundle)

open fun onStart()

open fun onStop()

open fun onViewCreated(@NonNull view: View, @Nullable savedInstanceState: Bundle?)

onViewStateRestored

open override fun onViewStateRestored(savedInstanceState: Bundle?)

performActivityCreated

open fun performActivityCreated(savedInstanceState: Bundle?)

open fun performAttach()

performConfigurationChanged

open fun performConfigurationChanged(@NonNull newConfig: Configuration)

performContextItemSelected

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

open fun performCreate(savedInstanceState: Bundle?)

performCreateOptionsMenu

open fun performCreateOptionsMenu(@NonNull menu: Menu, @NonNull inflater: MenuInflater): Boolean

performCreateView

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

open fun performDestroy()

performDestroyView

open fun performDestroyView()

open fun performDetach()

performGetLayoutInflater

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

performLowMemory

open fun performLowMemory()

performMultiWindowModeChanged

open fun performMultiWindowModeChanged(isInMultiWindowMode: Boolean)

performOptionsItemSelected

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

performOptionsMenuClosed

open fun performOptionsMenuClosed(@NonNull menu: Menu)

open fun performPause()

performPictureInPictureModeChanged

open fun performPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)

performPrepareOptionsMenu

open fun performPrepareOptionsMenu(@NonNull menu: Menu): Boolean

performPrimaryNavigationFragmentChanged

open fun performPrimaryNavigationFragmentChanged()

open fun performResume()

performSaveInstanceState

open fun performSaveInstanceState(outState: Bundle?)

open fun performStart()

open fun performStop()

performViewCreated

open fun performViewCreated()

postponeEnterTransition

open fun postponeEnterTransition()

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

prepareCallInternal

private open fun <I : Any?, O : Any?> prepareCallInternal(@NonNull contract: ActivityResultContract<I?, O?>, @NonNull registryProvider: Function<Void?, ActivityResultRegistry?>, @NonNull callback: ActivityResultCallback<O?>): ActivityResultLauncher<I?>

registerForActivityResult

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

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)

registerOnPreAttachListener

private open fun registerOnPreAttachListener(@NonNull callback: Fragment.OnPreAttachedListener)

requestPermissions

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

requireActivity

fun requireActivity(): FragmentActivity

requireArguments

fun requireArguments(): Bundle

fun requireContext(): Context

requireFragmentManager

fun ~~requireFragmentManager~~(): FragmentManager

fun requireHost(): Any

requireParentFragment

fun requireParentFragment(): Fragment

fun requireView(): View

restoreChildFragmentState

open fun restoreChildFragmentState()

restoreViewState

private open fun restoreViewState()

fun restoreViewState(savedInstanceState: Bundle?)

open fun setAnimations(@AnimRes enter: Int, @AnimRes exit: Int, @AnimRes popEnter: Int, @AnimRes popExit: Int)

setContentCardsViewBindingHandler

fun setContentCardsViewBindingHandler(value: IContentCardsViewBindingHandler?)

Set the IContentCardsViewBindingHandler responsible for rendering each Card in the RecyclerView. Note that this should only be set before the ContentCardsFragment is first displayed or the ContentCardAdapter will not update correctly.

setContentCardUpdateHandler

fun setContentCardUpdateHandler(value: IContentCardsUpdateHandler?)

Set the IContentCardsUpdateHandler for this ContentCardsFragment. This handler is for doing any work on Cards before being rendered in the ContentCards. If not set or set to null, the default handler will be used.

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)

setSharedElementNames

open fun setSharedElementNames(@Nullable sharedElementSourceNames: ArrayList<String?>?, @Nullable sharedElementTargetNames: ArrayList<String?>?)

setTargetFragment

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

shouldShowRequestPermissionRationale

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

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

swapRecyclerViewAdapter

protected fun swapRecyclerViewAdapter(newAdapter: RecyclerView.Adapter<*>)

Swaps the current RecyclerView for a new one. If the current adapter matches the new adapter, then this method does nothing.

unregisterForContextMenu

open fun unregisterForContextMenu(@NonNull view: View)