com.smartdevicelink.proxy.rpc

Class HMIPermissions

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.HMIPermissions

All Implemented Interfaces:

Cloneable

public class HMIPermissions
extends RPCStruct

Defining sets of HMI levels, which are permitted or prohibited for a given RPC.

Parameter List

Name	Type	Description	SmartDeviceLink Ver. Available
allowed	HMILevel	A set of all HMI levels that are permitted for this given RPC. Min: 0 Max: 100	SmartDeviceLink 2.0
userDisallowed	HMILevel	A set of all HMI levels that are prohibited for this given RPC. Min: 0 Max: 100	SmartDeviceLink 2.0

Since:

SmartDeviceLink 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_ALLOWED
static String	KEY_USER_DISALLOWED

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
HMIPermissions() Constructs a newly allocated HMIPermissions object
HMIPermissions(Hashtable<String,Object> hash) Constructs a newly allocated HMIPermissions object indicated by the Hashtable parameter
HMIPermissions(List<HMILevel> allowed, List<HMILevel> userDisallowed) Constructs a newly allocated HMIPermissions object

Method Summary

Modifier and Type	Method and Description
List<HMILevel>	getAllowed() get a set of all HMI levels that are permitted for this given RPC.
List<HMILevel>	getUserDisallowed() get a set of all HMI levels that are prohibited for this given RPC
HMIPermissions	setAllowed(List<HMILevel> allowed) set HMI level that is permitted for this given RPC.
HMIPermissions	setUserDisallowed(List<HMILevel> userDisallowed) set a set of all HMI levels that are prohibited for this given RPC

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_ALLOWED

public static final String KEY_ALLOWED

See Also:

Constant Field Values

KEY_USER_DISALLOWED

public static final String KEY_USER_DISALLOWED

See Also:

Constant Field Values

Constructor Detail

HMIPermissions

public HMIPermissions()

Constructs a newly allocated HMIPermissions object

HMIPermissions

public HMIPermissions(Hashtable<String,Object> hash)

Constructs a newly allocated HMIPermissions object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

HMIPermissions

public HMIPermissions(@NonNull
                      List<HMILevel> allowed,
                      @NonNull
                      List<HMILevel> userDisallowed)

Constructs a newly allocated HMIPermissions object

Parameters:

allowed - HMI level that is permitted for this given RPC

userDisallowed - HMI level that is prohibited for this given RPC

Method Detail

getAllowed

public List<HMILevel> getAllowed()

get a set of all HMI levels that are permitted for this given RPC.

Returns:

a set of all HMI levels that are permitted for this given RPC

setAllowed

public HMIPermissions setAllowed(@NonNull
                                 List<HMILevel> allowed)

set HMI level that is permitted for this given RPC.

Parameters:

allowed - HMI level that is permitted for this given RPC

getUserDisallowed

public List<HMILevel> getUserDisallowed()

get a set of all HMI levels that are prohibited for this given RPC

Returns:

a set of all HMI levels that are prohibited for this given RPC

setUserDisallowed

public HMIPermissions setUserDisallowed(@NonNull
                                        List<HMILevel> userDisallowed)

set a set of all HMI levels that are prohibited for this given RPC

Parameters:

userDisallowed - HMI level that is prohibited for this given RPC