Package 

Class CameraFragmentCompat

  • All Implemented Interfaces:
    android.content.ComponentCallbacks , android.view.View.OnCreateContextMenuListener , androidx.activity.result.ActivityResultCaller , androidx.lifecycle.HasDefaultViewModelProviderFactory , androidx.lifecycle.LifecycleOwner , androidx.lifecycle.ViewModelStoreOwner , androidx.savedstate.SavedStateRegistryOwner , net.gini.android.capture.camera.CameraFragmentInterface , net.gini.android.capture.internal.ui.FragmentImplCallback 
    
public class CameraFragmentCompat
extends Fragment implements CameraFragmentInterface, FragmentImplCallback

    CameraFragmentCompat is the main entry point to the Gini Capture SDK when using the Component API with the Android Support Library.

    It shows a camera preview with tap-to-focus functionality, a trigger button and an optional flash on/off button. The camera preview also shows document corner guides to which the user should align the document.

    If instantiated with createInstance then a button for importing documents is shown next to the trigger button. A hint popup is displayed the first time the Gini Capture SDK is used to inform the user about document importing.

    For importing documents READ_EXTERNAL_STORAGE permission is required and if the permission is not granted the Gini Capture SDK will prompt the user to grant the permission. See @{code Customizing the Camera Screen} on how to override the message and button titles for the rationale and on permission denial alerts.

    Note: Your Activity hosting this Fragment must extend the and use an AppCompat Theme.

    Include the CameraFragmentCompat into your layout either directly with <fragment> in your Activity's layout or using the androidx.fragment.app.FragmentManager and one of the createInstance() methods.

    A CameraFragmentListener instance must be available until the CameraFragmentCompat is attached to an activity. Failing to do so will throw an exception. The listener instance can be provided either implicitly by making the hosting Activity implement the CameraFragmentListener interface or explicitly by setting the listener using setListener.

    Your Activity is automatically set as the listener in onAttach.

    See the CameraActivity for details.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      static CameraFragmentCompat createInstance()
      void onCreate(Bundle savedInstanceState) Internal use only.
      View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) Internal use only.
      void onStart() Internal use only.
      void onResume() Internal use only.
      void onStop() Internal use only.
      void onSaveInstanceState(@NonNull() Bundle outState) Internal use only.
      void onDestroy() Internal use only.
      void onActivityResult(int requestCode, int resultCode, Intent data)
      void setListener(@NonNull() CameraFragmentListener listener) Set a listener for camera events.
      void showInterface() Call this method to show the interface elements.
      void hideInterface() Call this method to hide the interface elements.
      void showActivityIndicatorAndDisableInteraction() Call this method to show an activity indicator and disable user interaction.
      void hideActivityIndicatorAndEnableInteraction() Call this method to hide the activity indicator and enable user interaction.
      void showError(@NonNull() String message, int duration) Call this method to show an error message to the user in the Camera Screen.
      void showAlertDialog(@NonNull() String message, @NonNull() String positiveButtonTitle, @NonNull() DialogInterface.OnClickListener positiveButtonClickListener, @Nullable() String negativeButtonTitle, @Nullable() DialogInterface.OnClickListener negativeButtonClickListener, @Nullable() DialogInterface.OnCancelListener cancelListener)

      • Methods inherited from class androidx.fragment.app.Fragment

        dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getDefaultViewModelCreationExtras, getDefaultViewModelProviderFactory, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLifecycle, getLoaderManager, getParentFragment, getParentFragmentManager, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSavedStateRegistry, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewLifecycleOwner, getViewLifecycleOwnerLiveData, getViewModelStore, hasOptionsMenu, hashCode, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isStateSaved, isVisible, onActivityCreated, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroyOptionsMenu, onDestroyView, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPrepareOptionsMenu, onPrimaryNavigationFragmentChanged, onRequestPermissionsResult, onViewCreated, onViewStateRestored, postponeEnterTransition, registerForActivityResult, 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, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu

      • Methods inherited from class net.gini.android.capture.internal.ui.FragmentImplCallback

        getActivity, getView, startActivity, startActivityForResult

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait