org.researchstack.skin

Class PermissionRequestManager.PermissionRequest

java.lang.Object

org.researchstack.skin.PermissionRequestManager.PermissionRequest

Enclosing class:

PermissionRequestManager

public static class PermissionRequestManager.PermissionRequest
extends java.lang.Object

Class represents a permission that the user needs to grant

Constructor Summary

Constructors

Constructor and Description
PermissionRequest(java.lang.String id, int iconRes, int titleRes, int textRes) Default constructor to initialize a PermissinoRequest

Method Summary

Modifier and Type	Method and Description
int	getIcon() Icon of the permission used when displaying UI in the PermissionStepLayout
java.lang.String	getId() Returns the id of the permission.
int	getText() The explanation used when displaying UI in the PermissionStepLayout
int	getTitle() Title of the permission used when displaying UI in the PermissionStepLayout
boolean	isBlockingPermission() Returns true if this permissino is blocking
boolean	isSystemPermission() Returns true if PermissionRequest should be handled by the system grant flow
void	setIsBlockingPermission(boolean blocking) This paramter is used in the PermissionStepLayout that makes a permission optional or not.
void	setIsSystemPermission(boolean system) Sets to true if the permission should be handled by the system grant flow

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionRequest

public PermissionRequest(java.lang.String id,
                         @DrawableRes
                         int iconRes,
                         @StringRes
                         int titleRes,
                         @StringRes
                         int textRes)

Default constructor to initialize a PermissinoRequest

Parameters:

id - the id of the request

iconRes - the icon used to display a UI in the PermissionStepLayout

titleRes - the title used to display a UI in the PermissionStepLayout

textRes - the explanation used to display a UI in the PermissionStepLayout

Method Detail

getId

public java.lang.String getId()

Returns the id of the permission. If this is a system permission then it should originate from Manifest.permission

Returns:

id of the permission

getIcon

@DrawableRes
public int getIcon()

Icon of the permission used when displaying UI in the PermissionStepLayout

Returns:

drawable resource id

getTitle

@StringRes
public int getTitle()

Title of the permission used when displaying UI in the PermissionStepLayout

Returns:

string resource id

getText

@StringRes
public int getText()

The explanation used when displaying UI in the PermissionStepLayout

Returns:

string resource id

setIsBlockingPermission

public void setIsBlockingPermission(boolean blocking)

This paramter is used in the PermissionStepLayout that makes a permission optional or not. The user will not be allowed past the step if there are still some permissions havent been granted which this property set to true

Parameters:

blocking - true if the user needs to take action on this permission

isBlockingPermission

public boolean isBlockingPermission()

Returns true if this permissino is blocking

Returns:

true if the permission needs to be granted in PermissionStepLayout

setIsSystemPermission

public void setIsSystemPermission(boolean system)

Sets to true if the permission should be handled by the system grant flow

Parameters:

system - true if this is a system permission

isSystemPermission

public boolean isSystemPermission()

Returns true if PermissionRequest should be handled by the system grant flow

Returns:

true if PermissionRequest should be handled by the system grant flow