RegisterAppInterfaceResponse Class Reference
Constructors
Instance Methods
- getAudioPassThruCapabilities() ⇒
Array.<AudioPassThruCapabilities> - getButtonCapabilities() ⇒
Array.<ButtonCapabilities> - getDisplayCapabilities() ⇒
DisplayCapabilities - getHmiCapabilities() ⇒
HMICapabilities - getHmiDisplayLanguage() ⇒
Language - getHmiZoneCapabilities() ⇒
Array.<HmiZoneCapabilities> - getIconResumed() ⇒
Boolean - getLanguage() ⇒
Language - getPcmStreamCapabilities() ⇒
AudioPassThruCapabilities - getPrerecordedSpeech() ⇒
Array.<PrerecordedSpeech> - getPresetBankCapabilities() ⇒
PresetBankCapabilities - getSdlMsgVersion() ⇒
SdlMsgVersion - getSdlVersion() ⇒
String - getSoftButtonCapabilities() ⇒
Array.<SoftButtonCapabilities> - getSpeechCapabilities() ⇒
Array.<SpeechCapabilities> - getSupportedDiagModes() ⇒
Array.<Number> - getSystemSoftwareVersion() ⇒
String - getVehicleType() ⇒
VehicleType - getVrCapabilities() ⇒
Array.<VrCapabilities> - setAudioPassThruCapabilities(capabilities) ⇒
RegisterAppInterfaceResponse - setButtonCapabilities(capabilities) ⇒
RegisterAppInterfaceResponse - setDisplayCapabilities(capabilities) ⇒
RegisterAppInterfaceResponse - setHmiCapabilities(capabilities) ⇒
RegisterAppInterfaceResponse - setHmiDisplayLanguage(language) ⇒
RegisterAppInterfaceResponse - setHmiZoneCapabilities(capabilities) ⇒
RegisterAppInterfaceResponse - setIconResumed(resumed) ⇒
RegisterAppInterfaceResponse - setLanguage(language) ⇒
RegisterAppInterfaceResponse - setPcmStreamCapabilities(capabilities) ⇒
RegisterAppInterfaceResponse - setPrerecordedSpeech(speech) ⇒
RegisterAppInterfaceResponse - setPresetBankCapabilities(capabilities) ⇒
RegisterAppInterfaceResponse - setSdlMsgVersion(version) ⇒
RegisterAppInterfaceResponse - setSdlVersion(version) ⇒
RegisterAppInterfaceResponse - setSoftButtonCapabilities(capabilities) ⇒
RegisterAppInterfaceResponse - setSpeechCapabilities(capabilities) ⇒
RegisterAppInterfaceResponse - setSupportedDiagModes(modes) ⇒
RegisterAppInterfaceResponse - setSystemSoftwareVersion(version) ⇒
RegisterAppInterfaceResponse - setVehicleType(type) ⇒
RegisterAppInterfaceResponse - setVrCapabilities(capabilities) ⇒
RegisterAppInterfaceResponse
Constructors
new RegisterAppInterfaceResponse(parameters)
Initializes an instance of RegisterAppInterfaceResponse.
Instance Methods
registerAppInterfaceResponse.getAudioPassThruCapabilities() ⇒ Array.<AudioPassThruCapabilities>
Get the AudioPassThruCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: Array.<AudioPassThruCapabilities> - the KEY_AUDIO_PASS_THRU_CAPABILITIES value
registerAppInterfaceResponse.getButtonCapabilities() ⇒ Array.<ButtonCapabilities>
Get the ButtonCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: Array.<ButtonCapabilities> - the KEY_BUTTON_CAPABILITIES value
registerAppInterfaceResponse.getDisplayCapabilities() ⇒ DisplayCapabilities
Get the DisplayCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: DisplayCapabilities - the KEY_DISPLAY_CAPABILITIES value
registerAppInterfaceResponse.getHmiCapabilities() ⇒ HMICapabilities
Get the HmiCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: HMICapabilities - the KEY_HMI_CAPABILITIES value
registerAppInterfaceResponse.getHmiDisplayLanguage() ⇒ Language
Get the HmiDisplayLanguage
Kind: Instance method of RegisterAppInterfaceResponse
Returns: Language - the KEY_HMI_DISPLAY_LANGUAGE value
registerAppInterfaceResponse.getHmiZoneCapabilities() ⇒ Array.<HmiZoneCapabilities>
Get the HmiZoneCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: Array.<HmiZoneCapabilities> - the KEY_HMI_ZONE_CAPABILITIES value
registerAppInterfaceResponse.getIconResumed() ⇒ Boolean
Get the IconResumed
Kind: Instance method of RegisterAppInterfaceResponse
Returns: Boolean - the KEY_ICON_RESUMED value
registerAppInterfaceResponse.getLanguage() ⇒ Language
Get the Language
Kind: Instance method of RegisterAppInterfaceResponse
Returns: Language - the KEY_LANGUAGE value
registerAppInterfaceResponse.getPcmStreamCapabilities() ⇒ AudioPassThruCapabilities
Get the PcmStreamCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: AudioPassThruCapabilities - the KEY_PCM_STREAM_CAPABILITIES value
registerAppInterfaceResponse.getPrerecordedSpeech() ⇒ Array.<PrerecordedSpeech>
Get the PrerecordedSpeech
Kind: Instance method of RegisterAppInterfaceResponse
Returns: Array.<PrerecordedSpeech> - the KEY_PRERECORDED_SPEECH value
registerAppInterfaceResponse.getPresetBankCapabilities() ⇒ PresetBankCapabilities
Get the PresetBankCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: PresetBankCapabilities - the KEY_PRESET_BANK_CAPABILITIES value
registerAppInterfaceResponse.getSdlMsgVersion() ⇒ SdlMsgVersion
Get the SdlMsgVersion
Kind: Instance method of RegisterAppInterfaceResponse
Returns: SdlMsgVersion - the KEY_SDL_MSG_VERSION value
registerAppInterfaceResponse.getSdlVersion() ⇒ String
Get the SdlVersion
Kind: Instance method of RegisterAppInterfaceResponse
Returns: String - the KEY_SDL_VERSION value
registerAppInterfaceResponse.getSoftButtonCapabilities() ⇒ Array.<SoftButtonCapabilities>
Get the SoftButtonCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: Array.<SoftButtonCapabilities> - the KEY_SOFT_BUTTON_CAPABILITIES value
registerAppInterfaceResponse.getSpeechCapabilities() ⇒ Array.<SpeechCapabilities>
Get the SpeechCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: Array.<SpeechCapabilities> - the KEY_SPEECH_CAPABILITIES value
registerAppInterfaceResponse.getSupportedDiagModes() ⇒ Array.<Number>
Get the SupportedDiagModes
Kind: Instance method of RegisterAppInterfaceResponse
Returns: Array.<Number> - the KEY_SUPPORTED_DIAG_MODES value
registerAppInterfaceResponse.getSystemSoftwareVersion() ⇒ String
Get the SystemSoftwareVersion
Kind: Instance method of RegisterAppInterfaceResponse
Returns: String - the KEY_SYSTEM_SOFTWARE_VERSION value
registerAppInterfaceResponse.getVehicleType() ⇒ VehicleType
Get the VehicleType
Kind: Instance method of RegisterAppInterfaceResponse
Returns: VehicleType - the KEY_VEHICLE_TYPE value
registerAppInterfaceResponse.getVrCapabilities() ⇒ Array.<VrCapabilities>
Get the VrCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: Array.<VrCapabilities> - the KEY_VR_CAPABILITIES value
registerAppInterfaceResponse.setAudioPassThruCapabilities(capabilities) ⇒ RegisterAppInterfaceResponse
Set the AudioPassThruCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | Array.<AudioPassThruCapabilities> |
See AudioPassThruCapability - The desired AudioPassThruCapabilities. {'array_min_size': 1, 'array_max_size': 100} |
registerAppInterfaceResponse.setButtonCapabilities(capabilities) ⇒ RegisterAppInterfaceResponse
Set the ButtonCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | Array.<ButtonCapabilities> |
See ButtonCapabilities. This parameter is deprecated and replaced by SystemCapability using DISPLAYS. - The desired ButtonCapabilities. {'array_min_size': 1, 'array_max_size': 100} |
registerAppInterfaceResponse.setDisplayCapabilities(capabilities) ⇒ RegisterAppInterfaceResponse
Set the DisplayCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | DisplayCapabilities |
See DisplayCapabilities. This parameter is deprecated and replaced by SystemCapability using DISPLAYS. - The desired DisplayCapabilities. |
registerAppInterfaceResponse.setHmiCapabilities(capabilities) ⇒ RegisterAppInterfaceResponse
Set the HmiCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | HMICapabilities |
Specifies the HMI's capabilities. See HMICapabilities. - The desired HmiCapabilities. |
registerAppInterfaceResponse.setHmiDisplayLanguage(language) ⇒ RegisterAppInterfaceResponse
Set the HmiDisplayLanguage
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| language | Language |
The currently active display language on the module. See "Language" for options. - The desired HmiDisplayLanguage. |
registerAppInterfaceResponse.setHmiZoneCapabilities(capabilities) ⇒ RegisterAppInterfaceResponse
Set the HmiZoneCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | Array.<HmiZoneCapabilities> |
See HmiZoneCapabilities - The desired HmiZoneCapabilities. {'array_min_size': 1, 'array_max_size': 100} |
registerAppInterfaceResponse.setIconResumed(resumed) ⇒ RegisterAppInterfaceResponse
Set the IconResumed
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| resumed | Boolean |
Existence of apps icon at system. If true, apps icon was resumed at system. If false, apps icon is not resumed at system - The desired IconResumed. |
registerAppInterfaceResponse.setLanguage(language) ⇒ RegisterAppInterfaceResponse
Set the Language
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| language | Language |
The currently active VR+TTS language on the module. See "Language" for options. - The desired Language. |
registerAppInterfaceResponse.setPcmStreamCapabilities(capabilities) ⇒ RegisterAppInterfaceResponse
Set the PcmStreamCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | AudioPassThruCapabilities |
See AudioPassThruCapability - The desired PcmStreamCapabilities. |
registerAppInterfaceResponse.setPrerecordedSpeech(speech) ⇒ RegisterAppInterfaceResponse
Set the PrerecordedSpeech
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| speech | Array.<PrerecordedSpeech> |
See PrerecordedSpeech - The desired PrerecordedSpeech. {'array_min_size': 1, 'array_max_size': 100} |
registerAppInterfaceResponse.setPresetBankCapabilities(capabilities) ⇒ RegisterAppInterfaceResponse
Set the PresetBankCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | PresetBankCapabilities |
If returned, the platform supports custom on-screen Presets; see PresetBankCapabilities. This parameter is deprecated and replaced by SystemCapability using DISPLAYS. - The desired PresetBankCapabilities. |
registerAppInterfaceResponse.setSdlMsgVersion(version) ⇒ RegisterAppInterfaceResponse
Set the SdlMsgVersion
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| version | SdlMsgVersion |
See SyncMsgVersion - The desired SdlMsgVersion. |
registerAppInterfaceResponse.setSdlVersion(version) ⇒ RegisterAppInterfaceResponse
Set the SdlVersion
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| version | String |
The SmartDeviceLink version. - The desired SdlVersion. {'string_min_length': 1, 'string_max_length': 100} |
registerAppInterfaceResponse.setSoftButtonCapabilities(capabilities) ⇒ RegisterAppInterfaceResponse
Set the SoftButtonCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | Array.<SoftButtonCapabilities> |
If returned, the platform supports on-screen SoftButtons; see SoftButtonCapabilities. This parameter is deprecated and replaced by SystemCapability using DISPLAYS. - The desired SoftButtonCapabilities. {'array_min_size': 1, 'array_max_size': 100} |
registerAppInterfaceResponse.setSpeechCapabilities(capabilities) ⇒ RegisterAppInterfaceResponse
Set the SpeechCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | Array.<SpeechCapabilities> |
See SpeechCapabilities - The desired SpeechCapabilities. {'array_min_size': 1, 'array_max_size': 100} |
registerAppInterfaceResponse.setSupportedDiagModes(modes) ⇒ RegisterAppInterfaceResponse
Set the SupportedDiagModes
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| modes | Array.<Number> |
Specifies the white-list of supported diagnostic modes (0x00-0xFF) capable for DiagnosticMessage requests. If a mode outside this list is requested, it will be rejected. - The desired SupportedDiagModes. {'array_min_size': 1, 'array_max_size': 100, 'num_min_value': 0, 'num_max_value': 255} |
registerAppInterfaceResponse.setSystemSoftwareVersion(version) ⇒ RegisterAppInterfaceResponse
Set the SystemSoftwareVersion
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| version | String |
The software version of the system that implements the SmartDeviceLink core. - The desired SystemSoftwareVersion. {'string_min_length': 1, 'string_max_length': 100} |
registerAppInterfaceResponse.setVehicleType(type) ⇒ RegisterAppInterfaceResponse
Set the VehicleType
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| type | VehicleType |
Specifies the vehicle's type. See VehicleType. - The desired VehicleType. |
registerAppInterfaceResponse.setVrCapabilities(capabilities) ⇒ RegisterAppInterfaceResponse
Set the VrCapabilities
Kind: Instance method of RegisterAppInterfaceResponse
Returns: RegisterAppInterfaceResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | Array.<VrCapabilities> |
See VrCapabilities - The desired VrCapabilities. {'array_min_size': 1, 'array_max_size': 100} |