Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

Class ParameterPermissions

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct

Package
com.smartdevicelink.proxy.rpc

Overview

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

Parameter List

Name Type Description SmartDeviceLink Ver. Available
allowed String A set of all parameters that are permitted for this given RPC.
  • Min size: 0
  • Max size: 100
  • Max length: 100
SmartDeviceLink 2.0
userDisallowed String A set of all parameters that are prohibated for this given RPC.
  • Min size: 0
  • Max size: 100
  • Max length: 100
SmartDeviceLink 2.0

Fields

KEY_ALLOWED

public static final java.lang.String KEY_ALLOWED
Constant Value
"allowed"

KEY_USER_DISALLOWED

public static final java.lang.String KEY_USER_DISALLOWED
Constant Value
"userDisallowed"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

ParameterPermissions()

Constructs a newly allocated ParameterPermissions object

public ParameterPermissions()

ParameterPermissions( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a newly allocated ParameterPermissions object indicated by the Hashtable parameter

public ParameterPermissions(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Parameters

hash
The Hashtable to use

ParameterPermissions( java.util.List<java.lang.String> allowed, java.util.List<java.lang.String> userDisallowed )

Constructs a newly allocated ParameterPermissions object

public ParameterPermissions(java.util.List<java.lang.String> allowed,java.util.List<java.lang.String> userDisallowed)

Parameters

allowed
parameter that is permitted for this given RPC
userDisallowed
parameter that is prohibited for this given RPC

Methods

getAllowed()

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

public java.util.List getAllowed()

setAllowed( java.util.List<java.lang.String> allowed )

set a set of all parameters that are permitted for this given RPC.

public void setAllowed(java.util.List<java.lang.String> allowed)

Parameters

allowed
parameter that is permitted for this given RPC

getUserDisallowed()

get a set of all parameters that are prohibited for this given RPC.

public java.util.List getUserDisallowed()

setUserDisallowed( java.util.List<java.lang.String> userDisallowed )

set a set of all parameters that are prohibited for this given RPC.

public void setUserDisallowed(java.util.List<java.lang.String> userDisallowed)

Parameters

userDisallowed
paramter that is prohibited for this given RPC

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section