com.smartdevicelink.proxy.rpc

Class OnPermissionsChange

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCNotification

com.smartdevicelink.proxy.rpc.OnPermissionsChange

All Implemented Interfaces:

Cloneable

public class OnPermissionsChange
extends RPCNotification

Provides update to app of which sets of functions are available

HMI Status Requirements:

HMILevel:
• Any
AudioStreamingState:
• TBD
SystemContext:
• TBD

Parameter List:

Name	Type	Description	Req	Notes	SmartDeviceLink Ver Available
permissionItem	PermissionItem[]	Change in permissions for a given set of RPCs	Y	Minsize=1 Maxsize=100	SmartDeviceLink 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_PERMISSION_ITEM
static String	KEY_REQUIRE_ENCRYPTION

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
OnPermissionsChange() Constructs a newly allocated OnCommand object
OnPermissionsChange(Hashtable<String,Object> hash) Constructs a newly allocated OnPermissionsChange object indicated by the Hashtable parameter
OnPermissionsChange(List<PermissionItem> permissionItem) Constructs a newly allocated OnCommand object

Method Summary

Modifier and Type	Method and Description
List<PermissionItem>	getPermissionItem() Returns List object describing change in permissions for a given set of RPCs
Boolean	getRequireEncryption() Returns the encryption requirement for this permission change
OnPermissionsChange	setPermissionItem(List<PermissionItem> permissionItem) Sets PermissionItems describing change in permissions for a given set of RPCs
OnPermissionsChange	setRequireEncryption(Boolean isRequired) Sets the encryption requirement for this permission change

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, 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_PERMISSION_ITEM

public static final String KEY_PERMISSION_ITEM

See Also:

Constant Field Values

KEY_REQUIRE_ENCRYPTION

public static final String KEY_REQUIRE_ENCRYPTION

See Also:

Constant Field Values

Constructor Detail

OnPermissionsChange

public OnPermissionsChange()

Constructs a newly allocated OnCommand object

OnPermissionsChange

public OnPermissionsChange(Hashtable<String,Object> hash)

Constructs a newly allocated OnPermissionsChange object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

OnPermissionsChange

public OnPermissionsChange(@NonNull
                           List<PermissionItem> permissionItem)

Constructs a newly allocated OnCommand object

Parameters:

permissionItem - an List of PermissionItem describing change in permissions for a given set of RPCs

Method Detail

getPermissionItem

public List<PermissionItem> getPermissionItem()

Returns List object describing change in permissions for a given set of RPCs

Returns:

List<{ @ linkplain PermissionItem }> an object describing describing change in permissions for a given set of RPCs

setPermissionItem

public OnPermissionsChange setPermissionItem(@NonNull
                                             List<PermissionItem> permissionItem)

Sets PermissionItems describing change in permissions for a given set of RPCs

Parameters:

permissionItem - an List of PermissionItem describing change in permissions for a given set of RPCs

getRequireEncryption

public Boolean getRequireEncryption()

Returns the encryption requirement for this permission change

Returns:

true if encryption is required, false otherwise

setRequireEncryption

public OnPermissionsChange setRequireEncryption(Boolean isRequired)

Sets the encryption requirement for this permission change

Parameters:

isRequired - the boolean requirement to be set