WindowCapability Class Reference
Constructors
Instance Methods
- getButtonCapabilities() ⇒
Array.<ButtonCapabilities> - getDynamicUpdateCapabilities() ⇒
DynamicUpdateCapabilities - getImageFields() ⇒
Array.<ImageField> - getImageTypeSupported() ⇒
Array.<ImageType> - getKeyboardCapabilities() ⇒
KeyboardCapabilities - getMenuLayoutsAvailable() ⇒
Array.<MenuLayout> - getNumCustomPresetsAvailable() ⇒
Number - getSoftButtonCapabilities() ⇒
Array.<SoftButtonCapabilities> - getTemplatesAvailable() ⇒
Array.<String> - getTextFields() ⇒
Array.<TextField> - getWindowID() ⇒
Number - setButtonCapabilities(capabilities) ⇒
WindowCapability - setDynamicUpdateCapabilities(capabilities) ⇒
WindowCapability - setImageFields(fields) ⇒
WindowCapability - setImageTypeSupported(supported) ⇒
WindowCapability - setKeyboardCapabilities(capabilities) ⇒
WindowCapability - setMenuLayoutsAvailable(available) ⇒
WindowCapability - setNumCustomPresetsAvailable(available) ⇒
WindowCapability - setSoftButtonCapabilities(capabilities) ⇒
WindowCapability - setTemplatesAvailable(available) ⇒
WindowCapability - setTextFields(fields) ⇒
WindowCapability - setWindowID(id) ⇒
WindowCapability
Instance Methods
windowCapability.getButtonCapabilities() ⇒ Array.<ButtonCapabilities>
Get the ButtonCapabilities
Kind: Instance method of WindowCapability
Returns: Array.<ButtonCapabilities> - the KEY_BUTTON_CAPABILITIES value
windowCapability.getDynamicUpdateCapabilities() ⇒ DynamicUpdateCapabilities
Get the DynamicUpdateCapabilities
Kind: Instance method of WindowCapability
Returns: DynamicUpdateCapabilities - the KEY_DYNAMIC_UPDATE_CAPABILITIES value
windowCapability.getImageFields() ⇒ Array.<ImageField>
Get the ImageFields
Kind: Instance method of WindowCapability
Returns: Array.<ImageField> - the KEY_IMAGE_FIELDS value
windowCapability.getImageTypeSupported() ⇒ Array.<ImageType>
Get the ImageTypeSupported
Kind: Instance method of WindowCapability
Returns: Array.<ImageType> - the KEY_IMAGE_TYPE_SUPPORTED value
windowCapability.getKeyboardCapabilities() ⇒ KeyboardCapabilities
Get the KeyboardCapabilities
Kind: Instance method of WindowCapability
Returns: KeyboardCapabilities - the KEY_KEYBOARD_CAPABILITIES value
windowCapability.getMenuLayoutsAvailable() ⇒ Array.<MenuLayout>
Get the MenuLayoutsAvailable
Kind: Instance method of WindowCapability
Returns: Array.<MenuLayout> - the KEY_MENU_LAYOUTS_AVAILABLE value
windowCapability.getNumCustomPresetsAvailable() ⇒ Number
Get the NumCustomPresetsAvailable
Kind: Instance method of WindowCapability
Returns: Number - the KEY_NUM_CUSTOM_PRESETS_AVAILABLE value
windowCapability.getSoftButtonCapabilities() ⇒ Array.<SoftButtonCapabilities>
Get the SoftButtonCapabilities
Kind: Instance method of WindowCapability
Returns: Array.<SoftButtonCapabilities> - the KEY_SOFT_BUTTON_CAPABILITIES value
windowCapability.getTemplatesAvailable() ⇒ Array.<String>
Get the TemplatesAvailable
Kind: Instance method of WindowCapability
Returns: Array.<String> - the KEY_TEMPLATES_AVAILABLE value
windowCapability.getTextFields() ⇒ Array.<TextField>
Get the TextFields
Kind: Instance method of WindowCapability
Returns: Array.<TextField> - the KEY_TEXT_FIELDS value
windowCapability.getWindowID() ⇒ Number
Get the WindowID
Kind: Instance method of WindowCapability
Returns: Number - the KEY_WINDOW_ID value
windowCapability.setButtonCapabilities(capabilities) ⇒ WindowCapability
Set the ButtonCapabilities
Kind: Instance method of WindowCapability
Returns: WindowCapability - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | Array.<ButtonCapabilities> |
The number of buttons and the capabilities of each on-window button. - The desired ButtonCapabilities. {'array_min_size': 1, 'array_max_size': 100} |
windowCapability.setDynamicUpdateCapabilities(capabilities) ⇒ WindowCapability
Set the DynamicUpdateCapabilities
Kind: Instance method of WindowCapability
Returns: WindowCapability - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | DynamicUpdateCapabilities |
Contains the head unit's capabilities for dynamic updating features declaring if the module will send dynamic update RPCs. - The desired DynamicUpdateCapabilities. |
windowCapability.setImageFields(fields) ⇒ WindowCapability
Set the ImageFields
Kind: Instance method of WindowCapability
Returns: WindowCapability - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| fields | Array.<ImageField> |
A set of all fields that support images. See ImageField - The desired ImageFields. {'array_min_size': 1, 'array_max_size': 100} |
windowCapability.setImageTypeSupported(supported) ⇒ WindowCapability
Set the ImageTypeSupported
Kind: Instance method of WindowCapability
Returns: WindowCapability - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| supported | Array.<ImageType> |
Provides information about image types supported by the system. - The desired ImageTypeSupported. {'array_min_size': 0, 'array_max_size': 1000} |
windowCapability.setKeyboardCapabilities(capabilities) ⇒ WindowCapability
Set the KeyboardCapabilities
Kind: Instance method of WindowCapability
Returns: WindowCapability - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | KeyboardCapabilities |
See KeyboardCapabilities - The desired KeyboardCapabilities. |
windowCapability.setMenuLayoutsAvailable(available) ⇒ WindowCapability
Set the MenuLayoutsAvailable
Kind: Instance method of WindowCapability
Returns: WindowCapability - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Array.<MenuLayout> |
An array of available menu layouts. If this parameter is not provided, only the `LIST` layout is assumed to be available - The desired MenuLayoutsAvailable. {'array_min_size': 1, 'array_max_size': 1000} |
windowCapability.setNumCustomPresetsAvailable(available) ⇒ WindowCapability
Set the NumCustomPresetsAvailable
Kind: Instance method of WindowCapability
Returns: WindowCapability - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Number |
The number of on-window custom presets available (if any); otherwise omitted. - The desired NumCustomPresetsAvailable. {'num_min_value': 1, 'num_max_value': 100} |
windowCapability.setSoftButtonCapabilities(capabilities) ⇒ WindowCapability
Set the SoftButtonCapabilities
Kind: Instance method of WindowCapability
Returns: WindowCapability - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | Array.<SoftButtonCapabilities> |
The number of soft buttons available on-window and the capabilities for each button. - The desired SoftButtonCapabilities. {'array_min_size': 1, 'array_max_size': 100} |
windowCapability.setTemplatesAvailable(available) ⇒ WindowCapability
Set the TemplatesAvailable
Kind: Instance method of WindowCapability
Returns: WindowCapability - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Array.<String> |
A set of all window templates available on the head unit. - The desired TemplatesAvailable. {'array_min_size': 0, 'array_max_size': 100, 'string_min_length': 1, 'string_max_length': 100} |
windowCapability.setTextFields(fields) ⇒ WindowCapability
Set the TextFields
Kind: Instance method of WindowCapability
Returns: WindowCapability - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| fields | Array.<TextField> |
A set of all fields that support text data. See TextField - The desired TextFields. {'array_min_size': 1, 'array_max_size': 100} |
windowCapability.setWindowID(id) ⇒ WindowCapability
Set the WindowID
Kind: Instance method of WindowCapability
Returns: WindowCapability - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| id | Number |
The specified ID of the window. This ID is either one used when sending the CreateWindow request, or one of the predefined window ID values from the enum PredefinedWindows. If omitted, value is assumed to be the main window on the main display. - The desired WindowID. |