DynamicUpdateCapabilities Class Reference
Constructors
Instance Methods
- getSupportedDynamicImageFieldNames() ⇒
Array.<ImageFieldName> - getSupportsDynamicSubMenus() ⇒
Boolean - setSupportedDynamicImageFieldNames(names) ⇒
DynamicUpdateCapabilities - setSupportsDynamicSubMenus(menus) ⇒
DynamicUpdateCapabilities
Constructors
new DynamicUpdateCapabilities(parameters)
Initializes 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.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| 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. |