Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
DynamicUpdateCapabilities

DynamicUpdateCapabilities Class Reference

Constructors

Instance Methods

Constructors

new DynamicUpdateCapabilities(parameters)

Initalizes an instance of DynamicUpdateCapabilities.

Instance Methods

dynamicUpdateCapabilities.getSupportedDynamicImageFieldNames() ⇒ Array.<ImageFieldName>

Get the SupportedDynamicImageFieldNames

Kind: Instance method of DynamicUpdateCapabilities
Returns: Array.<ImageFieldName> - the KEY_SUPPORTED_DYNAMIC_IMAGE_FIELD_NAMES value

dynamicUpdateCapabilities.getSupportsDynamicSubMenus() ⇒ Boolean

Get the SupportsDynamicSubMenus

Kind: Instance method of DynamicUpdateCapabilities
Returns: Boolean - the KEY_SUPPORTS_DYNAMIC_SUB_MENUS value

dynamicUpdateCapabilities.setSupportedDynamicImageFieldNames(names) ⇒ DynamicUpdateCapabilities

Set the SupportedDynamicImageFieldNames

Kind: Instance method of DynamicUpdateCapabilities
Returns: DynamicUpdateCapabilities - The class instance for method chaining.

ParamTypeDescription
names Array.<ImageFieldName> 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. - The desired SupportedDynamicImageFieldNames. {'array_min_size': 1}

dynamicUpdateCapabilities.setSupportsDynamicSubMenus(menus) ⇒ DynamicUpdateCapabilities

Set the SupportsDynamicSubMenus

Kind: Instance method of DynamicUpdateCapabilities
Returns: DynamicUpdateCapabilities - The class instance for method chaining.

ParamTypeDescription
menus 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. - The desired SupportsDynamicSubMenus.
View on GitHub.com
Previous Section Next Section