com.ansca.corona.permissions

Class PermissionsSettings

java.lang.Object

com.ansca.corona.permissions.PermissionsSettings

public class PermissionsSettings
extends Object

Stores Permissions configuration options such as which permissions to request, why they're needed, how important they are to the app, etc.

Added in daily build 2016.2828.

Constructor Summary

Constructors

Constructor and Description
PermissionsSettings() Creates an object for storing Permissions settings.
PermissionsSettings(LinkedHashSet<String> permissions) Creates an object for storing Permissions settings.
PermissionsSettings(LinkedHashSet<String> permissions, int listener)
PermissionsSettings(LinkedHashSet<String> permissions, int listener, PermissionUrgency urgency)
PermissionsSettings(String permission) Creates an object for storing Permissions settings.
PermissionsSettings(String[] permissions) Creates an object for storing Permissions settings.
PermissionsSettings(String[] permissions, int listener)
PermissionsSettings(String[] permissions, int listener, PermissionUrgency urgency)
PermissionsSettings(String permission, int listener)
PermissionsSettings(String permission, int listener, PermissionUrgency urgency)

Method Summary

Methods

Modifier and Type	Method and Description
static PermissionsSettings	from(HashMap<String,Object> collection) Extracts the PermissionsSettings from a Corona Hashtable.
int	getListener()
LinkedHashSet<String>	getPermissions() Gets a collection of permissions that will be requested.
String	getRationaleDescription()
String	getRationaleTitle()
String	getSettingsRedirectDescription()
String	getSettingsRedirectTitle()
static HashMap<Integer,PermissionsSettings>	getSettingsToBeServiced()
PermissionUrgency	getUrgency()
void	markAsServiced() Puts this PermissionsSettings object in the "serviced" state.
boolean	needsService() Returns whether this PermissionsSettings object needs service.
void	resetServiceStatus() Puts this PermissionsSettings object in the "needs service" state.
void	setListener(int listenerRegistryId)
void	setPermissions(LinkedHashSet<String> newPermissions) Sets the collection of permissions to be requested.
void	setRationaleDescription(String rationaleDescription)
void	setRationaleTitle(String rationaleTitle)
void	setSettingsRedirectDescription(String settingsRedirectDescription)
void	setSettingsRedirectTitle(String settingsRedirectTitle)
void	setUrgency(PermissionUrgency urgency)

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionsSettings

public PermissionsSettings()

Creates an object for storing Permissions settings.

PermissionsSettings

public PermissionsSettings(String permission)

Creates an object for storing Permissions settings.

Parameters:

permission - The permission we wish to request.

PermissionsSettings

public PermissionsSettings(String permission,
                   int listener)

PermissionsSettings

public PermissionsSettings(String permission,
                   int listener,
                   PermissionUrgency urgency)

PermissionsSettings

public PermissionsSettings(String[] permissions)

Creates an object for storing Permissions settings.

Parameters:

permissions - An array of permissions we wish to request.

PermissionsSettings

public PermissionsSettings(String[] permissions,
                   int listener)

PermissionsSettings

public PermissionsSettings(String[] permissions,
                   int listener,
                   PermissionUrgency urgency)

PermissionsSettings

public PermissionsSettings(LinkedHashSet<String> permissions)

Creates an object for storing Permissions settings.

Parameters:

permissions - A LinkedHashSet of permissions we wish to request.

PermissionsSettings

public PermissionsSettings(LinkedHashSet<String> permissions,
                   int listener)

PermissionsSettings

public PermissionsSettings(LinkedHashSet<String> permissions,
                   int listener,
                   PermissionUrgency urgency)

Method Detail

getPermissions

public LinkedHashSet<String> getPermissions()

Gets a collection of permissions that will be requested.

Returns:

Returns a modifiable collection of strings.

setPermissions

public void setPermissions(LinkedHashSet<String> newPermissions)

Sets the collection of permissions to be requested.

Parameters:

newPermissions - The new permissions we want this PermissionsSettings object to hold.

getListener

public int getListener()

setListener

public void setListener(int listenerRegistryId)

getUrgency

public PermissionUrgency getUrgency()

setUrgency

public void setUrgency(PermissionUrgency urgency)

getRationaleTitle

public String getRationaleTitle()

setRationaleTitle

public void setRationaleTitle(String rationaleTitle)

getRationaleDescription

public String getRationaleDescription()

setRationaleDescription

public void setRationaleDescription(String rationaleDescription)

getSettingsRedirectTitle

public String getSettingsRedirectTitle()

setSettingsRedirectTitle

public void setSettingsRedirectTitle(String settingsRedirectTitle)

getSettingsRedirectDescription

public String getSettingsRedirectDescription()

setSettingsRedirectDescription

public void setSettingsRedirectDescription(String settingsRedirectDescription)

needsService

public boolean needsService()

Returns whether this PermissionsSettings object needs service.

markAsServiced

public void markAsServiced()

Puts this PermissionsSettings object in the "serviced" state.

resetServiceStatus

public void resetServiceStatus()

Puts this PermissionsSettings object in the "needs service" state.

getSettingsToBeServiced

public static HashMap<Integer,PermissionsSettings> getSettingsToBeServiced()

from

public static PermissionsSettings from(HashMap<String,Object> collection)

Extracts the PermissionsSettings from a Corona Hashtable.

Parameters:

collection - The HashMap to extract PermissionsSettings from.

Returns:

Returns a new PermissionsSettings object containing the information stored in the given hashtable. If the given table is invalid, then the returned object will be set to its defaults.