Class RegisterAppInterfaceResponse

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct
         com.smartdevicelink.proxy.RPCMessage
             com.smartdevicelink.proxy.RPCResponse

Package: com.smartdevicelink.proxy.rpc

Overview

Quick Jump

Fields

KEY_VEHICLE_TYPE
KEY_SPEECH_CAPABILITIES
KEY_VR_CAPABILITIES
KEY_AUDIO_PASS_THRU_CAPABILITIES
KEY_HMI_ZONE_CAPABILITIES
KEY_PRERECORDED_SPEECH
KEY_SUPPORTED_DIAG_MODES
KEY_SDL_MSG_VERSION
KEY_LANGUAGE
KEY_BUTTON_CAPABILITIES
KEY_DISPLAY_CAPABILITIES
KEY_HMI_DISPLAY_LANGUAGE
KEY_SOFT_BUTTON_CAPABILITIES
KEY_PRESET_BANK_CAPABILITIES
KEY_HMI_CAPABILITIES
KEY_SDL_VERSION
KEY_SYSTEM_SOFTWARE_VERSION
KEY_ICON_RESUMED
KEY_PCM_STREAM_CAPABILITIES

Constructors

RegisterAppInterfaceResponse()
RegisterAppInterfaceResponse( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
RegisterAppInterfaceResponse( Boolean success, Result resultCode )

Methods

format(Version rpcVersion,boolean formatParams)
getSdlMsgVersion()
setSdlMsgVersion(SdlMsgVersion sdlMsgVersion)
getLanguage()
setLanguage(Language language)
getHmiDisplayLanguage()
setHmiDisplayLanguage(Language hmiDisplayLanguage)
getDisplayCapabilities() Deprecated
setDisplayCapabilities(DisplayCapabilities displayCapabilities) Deprecated
getButtonCapabilities() Deprecated
setButtonCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.ButtonCapabilities> buttonCapabilities) Deprecated
getSoftButtonCapabilities() Deprecated
setSoftButtonCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.SoftButtonCapabilities> softButtonCapabilities) Deprecated
getPresetBankCapabilities() Deprecated
setPresetBankCapabilities(PresetBankCapabilities presetBankCapabilities) Deprecated
getHmiZoneCapabilities()
setHmiZoneCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.enums.HmiZoneCapabilities> hmiZoneCapabilities)
getSpeechCapabilities()
setSpeechCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.enums.SpeechCapabilities> speechCapabilities)
getPrerecordedSpeech()
setPrerecordedSpeech(java.util.List<com.smartdevicelink.proxy.rpc.enums.PrerecordedSpeech> prerecordedSpeech)
getVrCapabilities()
setVrCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.enums.VrCapabilities> vrCapabilities)
getVehicleType() Deprecated
setVehicleType(VehicleType vehicleType) Deprecated
getAudioPassThruCapabilities()
setAudioPassThruCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.AudioPassThruCapabilities> audioPassThruCapabilities)
getPcmStreamingCapabilities()
setPcmStreamingCapabilities(AudioPassThruCapabilities pcmStreamingCapabilities)
setSupportedDiagModes(java.util.List<java.lang.Integer> supportedDiagModes)
getSupportedDiagModes()
setHmiCapabilities(HMICapabilities hmiCapabilities)
getHmiCapabilities()
setSdlVersion(String sdlVersion)
getSdlVersion()
setSystemSoftwareVersion(String systemSoftwareVersion) Deprecated
getSystemSoftwareVersion() Deprecated
setIconResumed(Boolean iconResumed)
getIconResumed()

Fields

KEY_VEHICLE_TYPE

public static final java.lang.String KEY_VEHICLE_TYPE

Constant Value: "vehicleType"

KEY_SPEECH_CAPABILITIES

public static final java.lang.String KEY_SPEECH_CAPABILITIES

Constant Value: "speechCapabilities"

KEY_VR_CAPABILITIES

public static final java.lang.String KEY_VR_CAPABILITIES

Constant Value: "vrCapabilities"

KEY_AUDIO_PASS_THRU_CAPABILITIES

public static final java.lang.String KEY_AUDIO_PASS_THRU_CAPABILITIES

Constant Value: "audioPassThruCapabilities"

KEY_HMI_ZONE_CAPABILITIES

public static final java.lang.String KEY_HMI_ZONE_CAPABILITIES

Constant Value: "hmiZoneCapabilities"

KEY_PRERECORDED_SPEECH

public static final java.lang.String KEY_PRERECORDED_SPEECH

Constant Value: "prerecordedSpeech"

KEY_SUPPORTED_DIAG_MODES

public static final java.lang.String KEY_SUPPORTED_DIAG_MODES

Constant Value: "supportedDiagModes"

KEY_SDL_MSG_VERSION

public static final java.lang.String KEY_SDL_MSG_VERSION

Constant Value: "syncMsgVersion"

KEY_LANGUAGE

public static final java.lang.String KEY_LANGUAGE

Constant Value: "language"

KEY_BUTTON_CAPABILITIES

public static final java.lang.String KEY_BUTTON_CAPABILITIES

Constant Value: "buttonCapabilities"

KEY_DISPLAY_CAPABILITIES

public static final java.lang.String KEY_DISPLAY_CAPABILITIES

Constant Value: "displayCapabilities"

KEY_HMI_DISPLAY_LANGUAGE

public static final java.lang.String KEY_HMI_DISPLAY_LANGUAGE

Constant Value: "hmiDisplayLanguage"

KEY_SOFT_BUTTON_CAPABILITIES

public static final java.lang.String KEY_SOFT_BUTTON_CAPABILITIES

Constant Value: "softButtonCapabilities"

KEY_PRESET_BANK_CAPABILITIES

public static final java.lang.String KEY_PRESET_BANK_CAPABILITIES

Constant Value: "presetBankCapabilities"

KEY_HMI_CAPABILITIES

public static final java.lang.String KEY_HMI_CAPABILITIES

Constant Value: "hmiCapabilities"

KEY_SDL_VERSION

public static final java.lang.String KEY_SDL_VERSION

Constant Value: "sdlVersion"

KEY_SYSTEM_SOFTWARE_VERSION

public static final java.lang.String KEY_SYSTEM_SOFTWARE_VERSION

Constant Value: "systemSoftwareVersion"

KEY_ICON_RESUMED

public static final java.lang.String KEY_ICON_RESUMED

Constant Value: "iconResumed"

KEY_PCM_STREAM_CAPABILITIES

public static final java.lang.String KEY_PCM_STREAM_CAPABILITIES

Constant Value: "pcmStreamCapabilities"

Inherited Fields

From Class	Fields
com.smartdevicelink.proxy.RPCResponse	KEY_SUCCESS, KEY_INFO, KEY_RESULT_CODE
com.smartdevicelink.proxy.RPCMessage	KEY_REQUEST, KEY_RESPONSE, KEY_NOTIFICATION, KEY_FUNCTION_NAME, KEY_PARAMETERS, KEY_CORRELATION_ID, messageType, parameters, function
com.smartdevicelink.proxy.RPCStruct	KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

RegisterAppInterfaceResponse()

Constructs a new RegisterAppInterfaceResponse object

public RegisterAppInterfaceResponse()

RegisterAppInterfaceResponse( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a new RegisterAppInterfaceResponse object indicated by the Hashtable parameter

public RegisterAppInterfaceResponse(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Constructor Parameters

hash: The Hashtable to use

RegisterAppInterfaceResponse( Boolean success, Result resultCode )

Constructs a new RegisterAppInterfaceResponse object

public RegisterAppInterfaceResponse(Boolean success,Result resultCode)

Constructor Parameters

success: whether the request is successfully processed
resultCode: whether the request is successfully processed

Methods

format( Version rpcVersion, boolean formatParams )

public void format(Version rpcVersion,boolean formatParams)

Method Parameters

rpcVersion
formatParams

getSdlMsgVersion()

Gets the version of the SDL® SmartDeviceLink interface

public com.smartdevicelink.proxy.rpc.SdlMsgVersion getSdlMsgVersion()

setSdlMsgVersion( SdlMsgVersion sdlMsgVersion )

Sets the version of the SDL® SmartDeviceLink interface

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setSdlMsgVersion(SdlMsgVersion sdlMsgVersion)

Method Parameters

sdlMsgVersion: a SdlMsgVersion object representing version of the SDL® SmartDeviceLink interface
Notes: To be compatible, app msg major version number must be less than or equal to SDL® major version number. If msg versions are incompatible, app has 20 seconds to attempt successful RegisterAppInterface (w.r.t. msg version) on underlying protocol session, else will be terminated. Major version number is a compatibility declaration. Minor version number indicates minor functional variations (e.g. features, capabilities, bug fixes) when sent from SDL® to app (in RegisterAppInterface response). However, the minor version number sent from the app to SDL® (in RegisterAppInterface request) is ignored by SDL®

getLanguage()

Gets a Language enumeration indicating what language the application intends to use for user interaction (Display, TTS and VR)

public com.smartdevicelink.proxy.rpc.enums.Language getLanguage()

setLanguage( Language language )

Sets an enumeration indicating what language the application intends to use for user interaction (Display, TTS and VR)

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setLanguage(Language language)

Method Parameters

language: a Language Enumeration

getHmiDisplayLanguage()

Gets an enumeration indicating what language the application intends to use for user interaction ( Display)

public com.smartdevicelink.proxy.rpc.enums.Language getHmiDisplayLanguage()

setHmiDisplayLanguage( Language hmiDisplayLanguage )

Sets an enumeration indicating what language the application intends to use for user interaction ( Display)

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setHmiDisplayLanguage(Language hmiDisplayLanguage)

Method Parameters

hmiDisplayLanguage

getDisplayCapabilities()

Deprecated
Gets getDisplayCapabilities set when application interface is registered.

public com.smartdevicelink.proxy.rpc.DisplayCapabilities getDisplayCapabilities()

setDisplayCapabilities( DisplayCapabilities displayCapabilities )

Deprecated
Sets Display Capabilities

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setDisplayCapabilities(DisplayCapabilities displayCapabilities)

Method Parameters

displayCapabilities

getButtonCapabilities()

Deprecated
Gets buttonCapabilities set when application interface is registered.

public java.util.List getButtonCapabilities()

setButtonCapabilities( java.util.List<com.smartdevicelink.proxy.rpc.ButtonCapabilities> buttonCapabilities )

Deprecated
Sets Button Capabilities

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setButtonCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.ButtonCapabilities> buttonCapabilities)

Method Parameters

buttonCapabilities

getSoftButtonCapabilities()

Deprecated
Gets getSoftButtonCapabilities set when application interface is registered.

public java.util.List getSoftButtonCapabilities()

setSoftButtonCapabilities( java.util.List<com.smartdevicelink.proxy.rpc.SoftButtonCapabilities> softButtonCapabilities )

Deprecated
Sets softButtonCapabilities

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setSoftButtonCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.SoftButtonCapabilities> softButtonCapabilities)

Method Parameters

softButtonCapabilities

getPresetBankCapabilities()

Deprecated
Gets getPresetBankCapabilities set when application interface is registered.

public com.smartdevicelink.proxy.rpc.PresetBankCapabilities getPresetBankCapabilities()

setPresetBankCapabilities( PresetBankCapabilities presetBankCapabilities )

Deprecated
Sets presetBankCapabilities

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setPresetBankCapabilities(PresetBankCapabilities presetBankCapabilities)

Method Parameters

presetBankCapabilities

getHmiZoneCapabilities()

Gets hmiZoneCapabilities set when application interface is registered.

public java.util.List getHmiZoneCapabilities()

setHmiZoneCapabilities( java.util.List<com.smartdevicelink.proxy.rpc.enums.HmiZoneCapabilities> hmiZoneCapabilities )

Sets hmiZoneCapabilities

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setHmiZoneCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.enums.HmiZoneCapabilities> hmiZoneCapabilities)

Method Parameters

hmiZoneCapabilities

getSpeechCapabilities()

Gets speechCapabilities set when application interface is registered.

public java.util.List getSpeechCapabilities()

setSpeechCapabilities( java.util.List<com.smartdevicelink.proxy.rpc.enums.SpeechCapabilities> speechCapabilities )

Sets speechCapabilities

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setSpeechCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.enums.SpeechCapabilities> speechCapabilities)

Method Parameters

speechCapabilities

getPrerecordedSpeech()

public java.util.List getPrerecordedSpeech()

setPrerecordedSpeech( java.util.List<com.smartdevicelink.proxy.rpc.enums.PrerecordedSpeech> prerecordedSpeech )

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setPrerecordedSpeech(java.util.List<com.smartdevicelink.proxy.rpc.enums.PrerecordedSpeech> prerecordedSpeech)

Method Parameters

prerecordedSpeech

getVrCapabilities()

Gets vrCapabilities set when application interface is registered.

public java.util.List getVrCapabilities()

setVrCapabilities( java.util.List<com.smartdevicelink.proxy.rpc.enums.VrCapabilities> vrCapabilities )

Sets VrCapabilities

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setVrCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.enums.VrCapabilities> vrCapabilities)

Method Parameters

vrCapabilities

getVehicleType()

Deprecated
Gets getVehicleType set when application interface is registered.

public com.smartdevicelink.proxy.rpc.VehicleType getVehicleType()

setVehicleType( VehicleType vehicleType )

Deprecated
Sets vehicleType

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setVehicleType(VehicleType vehicleType)

Method Parameters

vehicleType

getAudioPassThruCapabilities()

Gets AudioPassThruCapabilities set when application interface is registered.

public java.util.List getAudioPassThruCapabilities()

setAudioPassThruCapabilities( java.util.List<com.smartdevicelink.proxy.rpc.AudioPassThruCapabilities> audioPassThruCapabilities )

Sets AudioPassThruCapabilities

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setAudioPassThruCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.AudioPassThruCapabilities> audioPassThruCapabilities)

Method Parameters

audioPassThruCapabilities

getPcmStreamingCapabilities()

Gets pcmStreamingCapabilities set when application interface is registered.

public com.smartdevicelink.proxy.rpc.AudioPassThruCapabilities getPcmStreamingCapabilities()

setPcmStreamingCapabilities( AudioPassThruCapabilities pcmStreamingCapabilities )

Sets pcmStreamingCapabilities

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setPcmStreamingCapabilities(AudioPassThruCapabilities pcmStreamingCapabilities)

Method Parameters

pcmStreamingCapabilities

setSupportedDiagModes( java.util.List<java.lang.Integer> supportedDiagModes )

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setSupportedDiagModes(java.util.List<java.lang.Integer> supportedDiagModes)

Method Parameters

supportedDiagModes

getSupportedDiagModes()

public java.util.List getSupportedDiagModes()

setHmiCapabilities( HMICapabilities hmiCapabilities )

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setHmiCapabilities(HMICapabilities hmiCapabilities)

Method Parameters

hmiCapabilities

getHmiCapabilities()

public com.smartdevicelink.proxy.rpc.HMICapabilities getHmiCapabilities()

setSdlVersion( String sdlVersion )

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setSdlVersion(String sdlVersion)

Method Parameters

sdlVersion

getSdlVersion()

public java.lang.String getSdlVersion()

setSystemSoftwareVersion( String systemSoftwareVersion )

Deprecated
The software version of the connected device.

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setSystemSoftwareVersion(String systemSoftwareVersion)

Method Parameters

systemSoftwareVersion: the version of software on the connected device

getSystemSoftwareVersion()

Deprecated
The software version of the connected device.

public java.lang.String getSystemSoftwareVersion()

setIconResumed( Boolean iconResumed )

Sets Icon Resumed Boolean

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse setIconResumed(Boolean iconResumed)

Method Parameters

iconResumed: - if param not included, set to false

getIconResumed()

Tells developer whether or not their app icon has been resumed on core.

public java.lang.Boolean getIconResumed()

Inherited Methods

From Class	Methods
com.smartdevicelink.proxy.RPCResponse	getCorrelationID, setCorrelationID, getSuccess, setSuccess, getResultCode, setResultCode, getInfo, setInfo
com.smartdevicelink.proxy.RPCMessage	getFunctionID, getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong
com.smartdevicelink.proxy.RPCStruct	getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode
java.lang.Object	getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize

View on GitHub.com

Previous Section Next Section