com.pega.mobile.accountmanager

Enum AccountManagerService

java.lang.Object

java.lang.Enum<AccountManagerService>

com.pega.mobile.accountmanager.AccountManagerService

All Implemented Interfaces:

Serializable, Comparable<AccountManagerService>

public enum AccountManagerService
extends Enum<AccountManagerService>

Handles and manages accounts. Its instance is available using INSTANCE property.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The singleton instance of AccountManagerService

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(AccountManagerListener listener) Registers a listener that will be called whenever an account is opened or closed.
String	getCurrentAccountIdentifier() Returns Id of currently authenticated user or null if not authenticated.
String	getCurrentAccountSecretServiceKey(String fieldName) Returns the internal key for a given service name.
Map<String,String>	getPrivateAccountData() Returns custom, private data associated with currently open account.
boolean	isOpened()
void	removeField(String key, boolean isPublic) Removes a given key (with associated value) from a custom fields map defined by scope.
void	removeListener(AccountManagerListener listener) Removes the listener added by addListener
String	setField(String key, String value, boolean isPublic) Sets given value for a given key in one of the custom fields map defined by scope.
static AccountManagerService	valueOf(String name) Returns the enum constant of this type with the specified name.
static AccountManagerService[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final AccountManagerService INSTANCE

The singleton instance of AccountManagerService

Method Detail

values

public static AccountManagerService[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AccountManagerService c : AccountManagerService.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AccountManagerService valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCurrentAccountIdentifier

public String getCurrentAccountIdentifier()

Returns Id of currently authenticated user or null if not authenticated.

Returns:

Id of currently authenticated user or null if not authenticated

getPrivateAccountData

public Map<String,String> getPrivateAccountData()
                                         throws AccountManagerException

Returns custom, private data associated with currently open account.

Returns:

Custom, private data associated with currently open account

Throws:

AccountManagerException

setField

public String setField(String key,
              String value,
              boolean isPublic)
                throws AccountManagerException

Sets given value for a given key in one of the custom fields map defined by scope. If a value exists under provided key, it is overwritten. Neither key nor value can be nil. Value must be serializable to a JSON string.

Parameters:

key - A string key under which value is persisted.

value - Custom value to be set. Must be serializable to JSON string.

isPublic - Flag determining whether field should be public or not

Returns:

Field value if added successfully, null otherwise.

Throws:

AccountManagerException

removeField

public void removeField(String key,
               boolean isPublic)
                 throws AccountManagerException

Removes a given key (with associated value) from a custom fields map defined by scope.

Parameters:

key - A string key to be removed.

isPublic - Flag determining whether field is public or not

Throws:

AccountManagerException

isOpened

public boolean isOpened()

getCurrentAccountSecretServiceKey

public String getCurrentAccountSecretServiceKey(String fieldName)
                                         throws AccountManagerException

Returns the internal key for a given service name. The key is generated and stored in an encrypted form, so subsequent requests return always the same key. There is no API to modify/remove this key, because it's supposed to be constant throughout the application lifetime on a device.

Parameters:

fieldName - Name of field.

Returns:

An internal key to be used for encryption purposes.

Throws:

AccountManagerException

addListener

public void addListener(AccountManagerListener listener)

Registers a listener that will be called whenever an account is opened or closed. It will also be called immediately to give back the current state.

Parameters:

listener - Listener object

removeListener

public void removeListener(AccountManagerListener listener)

Removes the listener added by addListener

Parameters:

listener - Listener object