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
DisplayCapability

DisplayCapability Class Reference

Constructors

Instance Methods

Constructors

new DisplayCapability(parameters)

Initalizes an instance of DisplayCapability.

Instance Methods

displayCapability.getDisplayName() ⇒ String

Get the DisplayName

Kind: Instance method of DisplayCapability
Returns: String - the KEY_DISPLAY_NAME value

displayCapability.getWindowCapabilities() ⇒ Array.<WindowCapability>

Get the WindowCapabilities

Kind: Instance method of DisplayCapability
Returns: Array.<WindowCapability> - the KEY_WINDOW_CAPABILITIES value

displayCapability.getWindowTypeSupported() ⇒ Array.<WindowTypeCapabilities>

Get the WindowTypeSupported

Kind: Instance method of DisplayCapability
Returns: Array.<WindowTypeCapabilities> - the KEY_WINDOW_TYPE_SUPPORTED value

displayCapability.setDisplayName(name) ⇒ DisplayCapability

Set the DisplayName

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

ParamTypeDescription
name String The desired DisplayName. {'string_min_length': 1}

displayCapability.setWindowCapabilities(capabilities) ⇒ DisplayCapability

Set the WindowCapabilities

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

ParamTypeDescription
capabilities Array.<WindowCapability> Contains a list of capabilities of all windows related to the app. Once the app has registered the capabilities of all windows are provided. GetSystemCapability still allows requesting window capabilities of all windows. After registration, only windows with capabilities changed will be included. Following cases will cause only affected windows to be included: 1. App creates a new window. After the window is created, a system capability notification will be sent related only to the created window. 2. App sets a new layout to the window. The new layout changes window capabilities. The notification will reflect those changes to the single window. - The desired WindowCapabilities. {'array_min_size': 1, 'array_max_size': 1000}

displayCapability.setWindowTypeSupported(supported) ⇒ DisplayCapability

Set the WindowTypeSupported

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

ParamTypeDescription
supported Array.<WindowTypeCapabilities> Informs the application how many windows the app is allowed to create per type. - The desired WindowTypeSupported. {'array_min_size': 1}
View on GitHub.com
Previous Section Next Section