com.smartdevicelink.proxy.rpc

Class DynamicUpdateCapabilities

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.DynamicUpdateCapabilities

All Implemented Interfaces:

Cloneable

public class DynamicUpdateCapabilities
extends RPCStruct

Parameter List

Param Name	Type	Description	Required	Version Available
supportedDynamicImageFieldNames	List	An array of ImageFieldName values for which the system supports sending OnFileUpdateNotifications. If you send an Image struct for that image field with a name without having uploaded the image data using PutFile that matches that name, the system will request that you upload the data with PutFile at a later point when the HMI needs it. The HMI will then display the image in the appropriate field. If not sent, assume false.	N
supportsDynamicSubMenus	Boolean	If true, the head unit supports dynamic sub-menus by sending OnUpdateSubMenuNotifications. If true, you should not send AddCommands that attach to a parentID for anAddSubMenu until OnUpdateSubMenu is received with the menuID. At that point, you should send all AddCommands with a parentID that match the menuID. If not set, assume false.	N

Since:

SmartDeviceLink 7.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_SUPPORTED_DYNAMIC_IMAGE_FIELD_NAMES
static String	KEY_SUPPORTS_DYNAMIC_SUB_MENUS

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
DynamicUpdateCapabilities() Constructs a new DynamicUpdateCapabilities object
DynamicUpdateCapabilities(Hashtable<String,Object> hash) Constructs a new DynamicUpdateCapabilities object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
List<ImageFieldName>	getSupportedDynamicImageFieldNames() Gets the supportedDynamicImageFieldNames.
Boolean	getSupportsDynamicSubMenus() Gets the supportsDynamicSubMenus.
DynamicUpdateCapabilities	setSupportedDynamicImageFieldNames(List<ImageFieldName> supportedDynamicImageFieldNames) Sets the supportedDynamicImageFieldNames.
DynamicUpdateCapabilities	setSupportsDynamicSubMenus(Boolean supportsDynamicSubMenus) Sets the supportsDynamicSubMenus.

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_SUPPORTED_DYNAMIC_IMAGE_FIELD_NAMES

public static final String KEY_SUPPORTED_DYNAMIC_IMAGE_FIELD_NAMES

See Also:

Constant Field Values

KEY_SUPPORTS_DYNAMIC_SUB_MENUS

public static final String KEY_SUPPORTS_DYNAMIC_SUB_MENUS

See Also:

Constant Field Values

Constructor Detail

DynamicUpdateCapabilities

public DynamicUpdateCapabilities()

Constructs a new DynamicUpdateCapabilities object

DynamicUpdateCapabilities

public DynamicUpdateCapabilities(Hashtable<String,Object> hash)

Constructs a new DynamicUpdateCapabilities object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

Method Detail

setSupportedDynamicImageFieldNames

public DynamicUpdateCapabilities setSupportedDynamicImageFieldNames(List<ImageFieldName> supportedDynamicImageFieldNames)

Sets the supportedDynamicImageFieldNames.

Parameters:

supportedDynamicImageFieldNames - An array of ImageFieldName values for which the system supports sending OnFileUpdate notifications. If you send an Image struct for that image field with a name without having uploaded the image data using PutFile that matches that name, the system will request that you upload the data with PutFile at a later point when the HMI needs it. The HMI will then display the image in the appropriate field. If not sent, assume false.

getSupportedDynamicImageFieldNames

public List<ImageFieldName> getSupportedDynamicImageFieldNames()

Gets the supportedDynamicImageFieldNames.

Returns:

List An array of ImageFieldName values for which the system supports sending OnFileUpdate notifications. If you send an Image struct for that image field with a name without having uploaded the image data using PutFile that matches that name, the system will request that you upload the data with PutFile at a later point when the HMI needs it. The HMI will then display the image in the appropriate field. If not sent, assume false.

setSupportsDynamicSubMenus

public DynamicUpdateCapabilities setSupportsDynamicSubMenus(Boolean supportsDynamicSubMenus)

Sets the supportsDynamicSubMenus.

Parameters:

supportsDynamicSubMenus - If true, the head unit supports dynamic sub-menus by sending OnUpdateSubMenu notifications. If true, you should not send AddCommands that attach to a parentID for an AddSubMenu until OnUpdateSubMenu is received with the menuID. At that point, you should send all AddCommands with a parentID that match the menuID. If not set, assume false.

getSupportsDynamicSubMenus

public Boolean getSupportsDynamicSubMenus()

Gets the supportsDynamicSubMenus.

Returns:

Boolean If true, the head unit supports dynamic sub-menus by sending OnUpdateSubMenu notifications. If true, you should not send AddCommands that attach to a parentID for an AddSubMenu until OnUpdateSubMenu is received with the menuID. At that point, you should send all AddCommands with a parentID that match the menuID. If not set, assume false.