com.tumblr.permissme

Class PermissMe

java.lang.Object

android.support.v4.app.Fragment

com.tumblr.permissme.PermissMe

All Implemented Interfaces:

ComponentCallbacks, View.OnCreateContextMenuListener

public class PermissMe
extends Fragment

The class that will handle requesting permissions if the app does not have a queried permission. This class is a Fragment that will be attached to the caller activity passed through the constructor: with(AppCompatActivity) or the activity the caller fragment is attached to, passed through with(Fragment) .

Exceptions: IllegalArgumentException thrown if caller activity/caller fragment's activity is not of type AppCompatActivity

Usage: For usage examples see the demo app or refer to ReadMe at: // TODO add link to the public repo here

Notes: PermissMe.Builder.mOptionalPermissions set through PermissMe.Builder.setOptionalPermissions(String...) will be queried iff the user grants the PermissMe.Builder.mRequiredPermissions set through PermissMe.Builder.setRequiredPermissions(String...).

If the caller does not specify PermissMe.Builder.setRequiredPermissions(String...), then the PermissMe.Builder.mOptionalPermissions will be queried as usual.

There are two PermissMe.Builder methods that will start the permissions flow: PermissMe.Builder.verifyPermissions() and PermissMe.Builder.launchActivityWithPermissions(Class, Bundle, Bundle) 1. PermissMe.Builder.launchActivityWithPermissions(Class, Bundle, Bundle) This should be used to launch a specific activity after the user successfully grants the PermissMe.Builder.mRequiredPermissions. The target activity will still be launched if the user denied PermissMe.Builder.mOptionalPermissions. To receive callbacks on which permissions were denied, use set a PermissMe.PermissionListener through setListener(PermissionListener) 2. PermissMe.Builder.verifyPermissions() This should be used to start the permissions flow from wherever in the flow it was executed; a callback can be provided by settings a PermissMe.PermissionListener through setListener(PermissionListener)

More information about usage and details can be foudn at: // TODO add link to the public repo here

Created by sumbul on 2/9/16.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PermissMe.Builder The Builder to make a permissions request.
static interface	PermissMe.PermissionListener Listener that can be used to receive a callback for the permission request made.

Nested classes/interfaces inherited from class android.support.v4.app.Fragment

Fragment.InstantiationException, Fragment.SavedState

Constructor Summary

Constructors

Constructor and Description
PermissMe()

Method Summary

Methods

Modifier and Type	Method and Description
void	onActivityResult(int requestCode, int resultCode, Intent data) This helper fragment should not be handling any callbacks, there should be a target fragment set through the builder using PermissMe.Builder.targetFragment(Fragment).
void	onCreate(Bundle savedInstanceState)
void	onDetach()
void	onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults)
static PermissMe.Builder	with(AppCompatActivity callerActivity) A constructor to start the flow of launching a destination activity class with permissions.
static PermissMe.Builder	with(Fragment callerFragment) A constructor to start the flow of verifying permissions; set a PermissMe.PermissionListener to receive callbacks about the grant/deny status of the permissions when the user takes an action.

Methods inherited from class android.support.v4.app.Fragment

dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isVisible, onActivityCreated, onAttach, onAttach, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateContextMenu, onCreateOptionsMenu, onCreateView, onDestroy, onDestroyOptionsMenu, onDestroyView, onHiddenChanged, onInflate, onInflate, onLowMemory, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPrepareOptionsMenu, onResume, onSaveInstanceState, onStart, onStop, onViewCreated, onViewStateRestored, registerForContextMenu, requestPermissions, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissMe

public PermissMe()

Method Detail

with

public static PermissMe.Builder with(AppCompatActivity callerActivity)

A constructor to start the flow of launching a destination activity class with permissions.

Parameters:

callerActivity - the caller activity

Returns:

A builder to add more parameters if necessary or call PermissMe.Builder.launchActivityWithPermissions(Class, Bundle, Bundle) or PermissMe.Builder.verifyPermissions() to start the flow

with

public static PermissMe.Builder with(Fragment callerFragment)

A constructor to start the flow of verifying permissions; set a PermissMe.PermissionListener to receive callbacks about the grant/deny status of the permissions when the user takes an action.

Parameters:

callerFragment - the caller fragment used to get the AppCompatActivity it is attached to

Returns:

A builder to add more parameters if necessary or call PermissMe.Builder.launchActivityWithPermissions(Class, Bundle, Bundle) or PermissMe.Builder.verifyPermissions() to start the flow

Throws:

IllegalArgumentException - if the callerFragment is attached to an activity that is not of type AppCompatActivity

onCreate

public void onCreate(Bundle savedInstanceState)

Overrides:

onCreate in class Fragment

onRequestPermissionsResult

public void onRequestPermissionsResult(int requestCode,
                              @NonNull
                              String[] permissions,
                              @NonNull
                              int[] grantResults)

Overrides:

onRequestPermissionsResult in class Fragment

onActivityResult

public void onActivityResult(int requestCode,
                    int resultCode,
                    Intent data)

This helper fragment should not be handling any callbacks, there should be a target fragment set through the builder using PermissMe.Builder.targetFragment(Fragment). The target fragment's Fragment.onActivityResult(int, int, Intent) will be called from here.

Overrides:

onActivityResult in class Fragment

onDetach

public void onDetach()

Overrides:

onDetach in class Fragment