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

Class RegisterAppInterfaceResponse

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

Register AppInterface Response is sent, when RegisterAppInterface has been called

Quick Jump

Fields
Constructors
Methods

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)

Parameters

hash
The Hashtable to use

RegisterAppInterfaceResponse( Boolean success, Result resultCode )

Constructs a new RegisterAppInterfaceResponse object

public RegisterAppInterfaceResponse(Boolean success,Result resultCode)

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)

Parameters

rpcVersion
formatParams

getSdlMsgVersion()

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

setSdlMsgVersion( SdlMsgVersion sdlMsgVersion )

Sets the version of the SDL® SmartDeviceLink interface

public void setSdlMsgVersion(SdlMsgVersion sdlMsgVersion)

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 void setLanguage(Language language)

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 void setHmiDisplayLanguage(Language hmiDisplayLanguage)

Parameters

hmiDisplayLanguage

getDisplayCapabilities()

Gets getDisplayCapabilities set when application interface is registered.

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

setDisplayCapabilities( DisplayCapabilities displayCapabilities )

Sets Display Capabilities

public void setDisplayCapabilities(DisplayCapabilities displayCapabilities)

Parameters

displayCapabilities

getButtonCapabilities()

Gets buttonCapabilities set when application interface is registered.

public java.util.List getButtonCapabilities()

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

Sets Button Capabilities

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

Parameters

buttonCapabilities

getSoftButtonCapabilities()

Gets getSoftButtonCapabilities set when application interface is registered.

public java.util.List getSoftButtonCapabilities()

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

Sets softButtonCapabilities

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

Parameters

softButtonCapabilities

getPresetBankCapabilities()

Gets getPresetBankCapabilities set when application interface is registered.

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

setPresetBankCapabilities( PresetBankCapabilities presetBankCapabilities )

Sets presetBankCapabilities

public void setPresetBankCapabilities(PresetBankCapabilities presetBankCapabilities)

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 void setHmiZoneCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.enums.HmiZoneCapabilities> hmiZoneCapabilities)

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 void setSpeechCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.enums.SpeechCapabilities> speechCapabilities)

Parameters

speechCapabilities

getPrerecordedSpeech()

public java.util.List getPrerecordedSpeech()

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

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

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 void setVrCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.enums.VrCapabilities> vrCapabilities)

Parameters

vrCapabilities

getVehicleType()

Gets getVehicleType set when application interface is registered.

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

setVehicleType( VehicleType vehicleType )

Sets vehicleType

public void setVehicleType(VehicleType vehicleType)

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 void setAudioPassThruCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.AudioPassThruCapabilities> audioPassThruCapabilities)

Parameters

audioPassThruCapabilities

getPcmStreamingCapabilities()

Gets pcmStreamingCapabilities set when application interface is registered.

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

setPcmStreamingCapabilities( AudioPassThruCapabilities pcmStreamingCapabilities )

Sets pcmStreamingCapabilities

public void setPcmStreamingCapabilities(AudioPassThruCapabilities pcmStreamingCapabilities)

Parameters

pcmStreamingCapabilities

getProxyVersionInfo()

public java.lang.String getProxyVersionInfo()

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

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

Parameters

supportedDiagModes

getSupportedDiagModes()

public java.util.List getSupportedDiagModes()

setHmiCapabilities( HMICapabilities hmiCapabilities )

public void setHmiCapabilities(HMICapabilities hmiCapabilities)

Parameters

hmiCapabilities

getHmiCapabilities()

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

setSdlVersion( String sdlVersion )

public void setSdlVersion(String sdlVersion)

Parameters

sdlVersion

getSdlVersion()

public java.lang.String getSdlVersion()

setSystemSoftwareVersion( String systemSoftwareVersion )

public void setSystemSoftwareVersion(String systemSoftwareVersion)

Parameters

systemSoftwareVersion

getSystemSoftwareVersion()

public java.lang.String getSystemSoftwareVersion()

setIconResumed( Boolean iconResumed )

Sets Icon Resumed Boolean

public void setIconResumed(Boolean iconResumed)

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 getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section