Package org.forgerock.android.auth.ui.callback

Class CallbackFragment<T extends org.forgerock.android.auth.callback.Callback>

java.lang.Object

androidx.fragment.app.Fragment

org.forgerock.android.auth.ui.callback.CallbackFragment<T>

Type Parameters:

T - The Callback Class defined or registered under CallbackFragmentFactory

All Implemented Interfaces:

android.content.ComponentCallbacks, android.view.View.OnCreateContextMenuListener, androidx.lifecycle.HasDefaultViewModelProviderFactory, androidx.lifecycle.LifecycleOwner, androidx.lifecycle.ViewModelStoreOwner, androidx.savedstate.SavedStateRegistryOwner

Direct Known Subclasses:

AbstractValidatedCallbackFragment, ChoiceCallbackFragment, ConfirmationCallbackFragment, ConsentMappingCallbackFragment, DeviceProfileCallbackFragment, IdPCallbackFragment, KbaCreateCallbackFragment, NameCallbackFragment, PasswordCallbackFragment, PollingWaitCallbackFragment, ReCaptchaCallbackFragment, SelectIdPCallbackFragment, SuspendedTextOutputCallbackFragment, TermsAndConditionsCallbackFragment, TextOutputCallbackFragment, WebAuthnAuthenticationCallbackFragment, WebAuthnRegistrationCallbackFragment

public abstract class CallbackFragment<T extends org.forgerock.android.auth.callback.Callback>
extends androidx.fragment.app.Fragment

UI Fragment which represent a Callback

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

Modifier and Type	Field	Description
protected T	callback	The Callback class see Callback
protected org.forgerock.android.auth.Node	node	The Callback's Node Node

Constructor Summary

Constructors

Constructor	Description
CallbackFragment()

Method Summary

Modifier and Type	Method	Description
void	cancel(java.lang.Exception e)	Cancel the authentication and exist the intelligent tree
void	next()	Proceed to next node from the intelligent tree.
void	onAttach(android.content.Context context)
void	onCreate(android.os.Bundle savedInstanceState)
void	onDataCollected()	Call when data is collected from the callback.
void	onDetach()
void	suspend()	Suspend the current authentication flow.

Methods inherited from class androidx.fragment.app.Fragment

dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getDefaultViewModelProviderFactory, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLifecycle, getLoaderManager, getParentFragment, getParentFragmentManager, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSavedStateRegistry, 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, onActivityCreated, onActivityResult, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onCreateView, onDestroy, onDestroyOptionsMenu, onDestroyView, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPrepareOptionsMenu, onPrimaryNavigationFragmentChanged, onRequestPermissionsResult, onResume, onSaveInstanceState, onStart, onStop, onViewCreated, onViewStateRestored, postponeEnterTransition, postponeEnterTransition, registerForContextMenu, requestPermissions, requireActivity, requireArguments, requireContext, requireFragmentManager, requireHost, requireParentFragment, requireView, 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

Field Detail

node

protected org.forgerock.android.auth.Node node

The Callback's Node Node

callback

protected T extends org.forgerock.android.auth.callback.Callback callback

The Callback class see Callback

Constructor Detail

CallbackFragment

public CallbackFragment()

Method Detail

onCreate

public void onCreate(android.os.Bundle savedInstanceState)

Overrides:

onCreate in class androidx.fragment.app.Fragment

onAttach

public void onAttach(android.content.Context context)

Overrides:

onAttach in class androidx.fragment.app.Fragment

onDetach

public void onDetach()

Overrides:

onDetach in class androidx.fragment.app.Fragment

onDataCollected

public void onDataCollected()

Call when data is collected from the callback.

next

public void next()

Proceed to next node from the intelligent tree.

cancel

public void cancel(java.lang.Exception e)

Cancel the authentication and exist the intelligent tree

Parameters:

e - The exception cause to exist the intelligent tree.

suspend

public void suspend()

Suspend the current authentication flow.