Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
RegisterAppInterfaceResponse

RegisterAppInterfaceResponse Class Reference

Constructors

Instance Methods

Constructors

new RegisterAppInterfaceResponse(parameters)

Initalizes 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.

ParamTypeDescription
capabilities Array.<AudioPassThruCapabilities> See AudioPassThruCapability - The desired AudioPassThruCapabilities.

registerAppInterfaceResponse.setButtonCapabilities(capabilities) ⇒ RegisterAppInterfaceResponse

Set the ButtonCapabilities

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

ParamTypeDescription
capabilities Array.<ButtonCapabilities> See ButtonCapabilities. This parameter is deprecated and replaced by - The desired ButtonCapabilities. SystemCapability using DISPLAYS.

registerAppInterfaceResponse.setDisplayCapabilities(capabilities) ⇒ RegisterAppInterfaceResponse

Set the DisplayCapabilities

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

ParamTypeDescription
capabilities DisplayCapabilities See DisplayCapabilities. This parameter is deprecated and replaced by - The desired DisplayCapabilities. SystemCapability using DISPLAYS.

registerAppInterfaceResponse.setHmiCapabilities(capabilities) ⇒ RegisterAppInterfaceResponse

Set the HmiCapabilities

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

ParamTypeDescription
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.

ParamTypeDescription
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.

ParamTypeDescription
capabilities Array.<HmiZoneCapabilities> See HmiZoneCapabilities - The desired HmiZoneCapabilities.

registerAppInterfaceResponse.setIconResumed(resumed) ⇒ RegisterAppInterfaceResponse

Set the IconResumed

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

ParamTypeDescription
resumed Boolean Existence of apps icon at system. If true, apps icon was resumed at system. If false, - The desired IconResumed. apps icon is not resumed at system

registerAppInterfaceResponse.setLanguage(language) ⇒ RegisterAppInterfaceResponse

Set the Language

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

ParamTypeDescription
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.

ParamTypeDescription
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.

ParamTypeDescription
speech Array.<PrerecordedSpeech> See PrerecordedSpeech - The desired PrerecordedSpeech.

registerAppInterfaceResponse.setPresetBankCapabilities(capabilities) ⇒ RegisterAppInterfaceResponse

Set the PresetBankCapabilities

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

ParamTypeDescription
capabilities PresetBankCapabilities If returned, the platform supports custom on-screen Presets; see - The desired PresetBankCapabilities. PresetBankCapabilities. This parameter is deprecated and replaced by SystemCapability using DISPLAYS.

registerAppInterfaceResponse.setSdlMsgVersion(version) ⇒ RegisterAppInterfaceResponse

Set the SdlMsgVersion

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

ParamTypeDescription
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.

ParamTypeDescription
version String The SmartDeviceLink version. - The desired SdlVersion.

registerAppInterfaceResponse.setSoftButtonCapabilities(capabilities) ⇒ RegisterAppInterfaceResponse

Set the SoftButtonCapabilities

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

ParamTypeDescription
capabilities Array.<SoftButtonCapabilities> If returned, the platform supports on-screen SoftButtons; see - The desired SoftButtonCapabilities. SoftButtonCapabilities. This parameter is deprecated and replaced by SystemCapability using DISPLAYS.

registerAppInterfaceResponse.setSpeechCapabilities(capabilities) ⇒ RegisterAppInterfaceResponse

Set the SpeechCapabilities

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

ParamTypeDescription
capabilities Array.<SpeechCapabilities> See SpeechCapabilities - The desired SpeechCapabilities.

registerAppInterfaceResponse.setSupportedDiagModes(modes) ⇒ RegisterAppInterfaceResponse

Set the SupportedDiagModes

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

ParamTypeDescription
modes Array.<Number> Specifies the white-list of supported diagnostic modes (0x00-0xFF) capable for - The desired SupportedDiagModes. DiagnosticMessage requests. If a mode outside this list is requested, it will be rejected.

registerAppInterfaceResponse.setSystemSoftwareVersion(version) ⇒ RegisterAppInterfaceResponse

Set the SystemSoftwareVersion

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

ParamTypeDescription
version String The software version of the system that implements the SmartDeviceLink core. - The desired SystemSoftwareVersion.

registerAppInterfaceResponse.setVehicleType(type) ⇒ RegisterAppInterfaceResponse

Set the VehicleType

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

ParamTypeDescription
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.

ParamTypeDescription
capabilities Array.<VrCapabilities> See VrCapabilities - The desired VrCapabilities.
View on GitHub.com
Previous Section Next Section