com.smartdevicelink.proxy.rpc

Class RegisterAppInterfaceResponse

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCResponse

com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse

All Implemented Interfaces:

Cloneable

public class RegisterAppInterfaceResponse
extends RPCResponse

Register AppInterface Response is sent, when RegisterAppInterface has been called

Since:

SmartDeviceLink 1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_AUDIO_PASS_THRU_CAPABILITIES
static String	KEY_BUTTON_CAPABILITIES Deprecated.
static String	KEY_DISPLAY_CAPABILITIES Deprecated.
static String	KEY_HMI_CAPABILITIES
static String	KEY_HMI_DISPLAY_LANGUAGE
static String	KEY_HMI_ZONE_CAPABILITIES
static String	KEY_ICON_RESUMED
static String	KEY_LANGUAGE
static String	KEY_PCM_STREAM_CAPABILITIES
static String	KEY_PRERECORDED_SPEECH
static String	KEY_PRESET_BANK_CAPABILITIES Deprecated.
static String	KEY_SDL_MSG_VERSION
static String	KEY_SDL_VERSION
static String	KEY_SOFT_BUTTON_CAPABILITIES Deprecated.
static String	KEY_SPEECH_CAPABILITIES
static String	KEY_SUPPORTED_DIAG_MODES
static String	KEY_SYSTEM_SOFTWARE_VERSION Deprecated.
static String	KEY_VEHICLE_TYPE Deprecated.
static String	KEY_VR_CAPABILITIES

Fields inherited from class com.smartdevicelink.proxy.RPCResponse

KEY_INFO, KEY_RESULT_CODE, KEY_SUCCESS

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
RegisterAppInterfaceResponse() Constructs a new RegisterAppInterfaceResponse object
RegisterAppInterfaceResponse(Boolean success, Result resultCode) Constructs a new RegisterAppInterfaceResponse object
RegisterAppInterfaceResponse(Hashtable<String,Object> hash) Constructs a new RegisterAppInterfaceResponse object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
void	format(Version rpcVersion, boolean formatParams) This method should clean the the RPC to make sure it is compliant with the spec.
List<AudioPassThruCapabilities>	getAudioPassThruCapabilities() Gets AudioPassThruCapabilities set when application interface is registered.
List<ButtonCapabilities>	getButtonCapabilities() Deprecated.
DisplayCapabilities	getDisplayCapabilities() Deprecated.
HMICapabilities	getHmiCapabilities()
Language	getHmiDisplayLanguage() Gets an enumeration indicating what language the application intends to use for user interaction ( Display)
List<HmiZoneCapabilities>	getHmiZoneCapabilities() Gets hmiZoneCapabilities set when application interface is registered.
Boolean	getIconResumed() Tells developer whether or not their app icon has been resumed on core.
Language	getLanguage() Gets a Language enumeration indicating what language the application intends to use for user interaction (Display, TTS and VR)
AudioPassThruCapabilities	getPcmStreamingCapabilities() Gets pcmStreamingCapabilities set when application interface is registered.
List<PrerecordedSpeech>	getPrerecordedSpeech()
PresetBankCapabilities	getPresetBankCapabilities() Deprecated.
SdlMsgVersion	getSdlMsgVersion() Gets the version of the SDL® SmartDeviceLink interface
String	getSdlVersion()
List<SoftButtonCapabilities>	getSoftButtonCapabilities() Deprecated.
List<SpeechCapabilities>	getSpeechCapabilities() Gets speechCapabilities set when application interface is registered.
List<Integer>	getSupportedDiagModes()
String	getSystemSoftwareVersion() Deprecated. in SmartDeviceLink 7.1.0
VehicleType	getVehicleType() Deprecated. in SmartDeviceLink 7.1.0
List<VrCapabilities>	getVrCapabilities() Gets vrCapabilities set when application interface is registered.
RegisterAppInterfaceResponse	setAudioPassThruCapabilities(List<AudioPassThruCapabilities> audioPassThruCapabilities) Sets AudioPassThruCapabilities
RegisterAppInterfaceResponse	setButtonCapabilities(List<ButtonCapabilities> buttonCapabilities) Deprecated.
RegisterAppInterfaceResponse	setDisplayCapabilities(DisplayCapabilities displayCapabilities) Deprecated.
RegisterAppInterfaceResponse	setHmiCapabilities(HMICapabilities hmiCapabilities)
RegisterAppInterfaceResponse	setHmiDisplayLanguage(Language hmiDisplayLanguage) Sets an enumeration indicating what language the application intends to use for user interaction ( Display)
RegisterAppInterfaceResponse	setHmiZoneCapabilities(List<HmiZoneCapabilities> hmiZoneCapabilities) Sets hmiZoneCapabilities
RegisterAppInterfaceResponse	setIconResumed(Boolean iconResumed) Sets Icon Resumed Boolean
RegisterAppInterfaceResponse	setLanguage(Language language) Sets an enumeration indicating what language the application intends to use for user interaction (Display, TTS and VR)
RegisterAppInterfaceResponse	setPcmStreamingCapabilities(AudioPassThruCapabilities pcmStreamingCapabilities) Sets pcmStreamingCapabilities
RegisterAppInterfaceResponse	setPrerecordedSpeech(List<PrerecordedSpeech> prerecordedSpeech)
RegisterAppInterfaceResponse	setPresetBankCapabilities(PresetBankCapabilities presetBankCapabilities) Deprecated.
RegisterAppInterfaceResponse	setSdlMsgVersion(SdlMsgVersion sdlMsgVersion) Sets the version of the SDL® SmartDeviceLink interface
RegisterAppInterfaceResponse	setSdlVersion(String sdlVersion)
RegisterAppInterfaceResponse	setSoftButtonCapabilities(List<SoftButtonCapabilities> softButtonCapabilities) Deprecated.
RegisterAppInterfaceResponse	setSpeechCapabilities(List<SpeechCapabilities> speechCapabilities) Sets speechCapabilities
RegisterAppInterfaceResponse	setSupportedDiagModes(List<Integer> supportedDiagModes)
RegisterAppInterfaceResponse	setSystemSoftwareVersion(String systemSoftwareVersion) Deprecated. in SmartDeviceLink 7.1.0
RegisterAppInterfaceResponse	setVehicleType(VehicleType vehicleType) Deprecated. in SmartDeviceLink 7.1.0
RegisterAppInterfaceResponse	setVrCapabilities(List<VrCapabilities> vrCapabilities) Sets VrCapabilities

Methods inherited from class com.smartdevicelink.proxy.RPCResponse

getCorrelationID, getInfo, getResultCode, getSuccess, setCorrelationID, setInfo, setResultCode, setSuccess

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_VEHICLE_TYPE

@Deprecated
public static final String KEY_VEHICLE_TYPE

Deprecated.

See Also:

Constant Field Values

KEY_SPEECH_CAPABILITIES

public static final String KEY_SPEECH_CAPABILITIES

See Also:

Constant Field Values

KEY_VR_CAPABILITIES

public static final String KEY_VR_CAPABILITIES

See Also:

Constant Field Values

KEY_AUDIO_PASS_THRU_CAPABILITIES

public static final String KEY_AUDIO_PASS_THRU_CAPABILITIES

See Also:

Constant Field Values

KEY_HMI_ZONE_CAPABILITIES

public static final String KEY_HMI_ZONE_CAPABILITIES

See Also:

Constant Field Values

KEY_PRERECORDED_SPEECH

public static final String KEY_PRERECORDED_SPEECH

See Also:

Constant Field Values

KEY_SUPPORTED_DIAG_MODES

public static final String KEY_SUPPORTED_DIAG_MODES

See Also:

Constant Field Values

KEY_SDL_MSG_VERSION

public static final String KEY_SDL_MSG_VERSION

See Also:

Constant Field Values

KEY_LANGUAGE

public static final String KEY_LANGUAGE

See Also:

Constant Field Values

KEY_BUTTON_CAPABILITIES

@Deprecated
public static final String KEY_BUTTON_CAPABILITIES

Deprecated.

See Also:

Constant Field Values

KEY_DISPLAY_CAPABILITIES

@Deprecated
public static final String KEY_DISPLAY_CAPABILITIES

Deprecated.

See Also:

Constant Field Values

KEY_HMI_DISPLAY_LANGUAGE

public static final String KEY_HMI_DISPLAY_LANGUAGE

See Also:

Constant Field Values

KEY_SOFT_BUTTON_CAPABILITIES

@Deprecated
public static final String KEY_SOFT_BUTTON_CAPABILITIES

Deprecated.

See Also:

Constant Field Values

KEY_PRESET_BANK_CAPABILITIES

@Deprecated
public static final String KEY_PRESET_BANK_CAPABILITIES

Deprecated.

See Also:

Constant Field Values

KEY_HMI_CAPABILITIES

public static final String KEY_HMI_CAPABILITIES

See Also:

Constant Field Values

KEY_SDL_VERSION

public static final String KEY_SDL_VERSION

See Also:

Constant Field Values

KEY_SYSTEM_SOFTWARE_VERSION

@Deprecated
public static final String KEY_SYSTEM_SOFTWARE_VERSION

Deprecated.

See Also:

Constant Field Values

KEY_ICON_RESUMED

public static final String KEY_ICON_RESUMED

See Also:

Constant Field Values

KEY_PCM_STREAM_CAPABILITIES

public static final String KEY_PCM_STREAM_CAPABILITIES

See Also:

Constant Field Values

Constructor Detail

RegisterAppInterfaceResponse

public RegisterAppInterfaceResponse()

Constructs a new RegisterAppInterfaceResponse object

RegisterAppInterfaceResponse

public RegisterAppInterfaceResponse(Hashtable<String,Object> hash)

Constructs a new RegisterAppInterfaceResponse object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

RegisterAppInterfaceResponse

public RegisterAppInterfaceResponse(@NonNull
                                    Boolean success,
                                    @NonNull
                                    Result resultCode)

Constructs a new RegisterAppInterfaceResponse object

Parameters:

success - whether the request is successfully processed

resultCode - whether the request is successfully processed

Method Detail

format

public void format(Version rpcVersion,
                   boolean formatParams)

Description copied from class: RPCStruct

This method should clean the the RPC to make sure it is compliant with the spec.

NOTE: Super needs to be called at the END of the method

Overrides:

format in class RPCStruct

Parameters:

rpcVersion - the rpc spec version that has been negotiated. If value is null the the max value of RPC spec version this library supports should be used.

formatParams - if true, the format method will be called on subsequent params

getSdlMsgVersion

public SdlMsgVersion getSdlMsgVersion()

Gets the version of the SDL® SmartDeviceLink interface

Returns:

SdlMsgVersion -a SdlMsgVersion object representing version of the SDL® SmartDeviceLink interface

setSdlMsgVersion

public RegisterAppInterfaceResponse setSdlMsgVersion(SdlMsgVersion sdlMsgVersion)

Sets the version of the SDL® SmartDeviceLink interface

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

public Language getLanguage()

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

Returns:

Enumeration -a language enumeration

setLanguage

public RegisterAppInterfaceResponse setLanguage(Language language)

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

Parameters:

language - a Language Enumeration

getHmiDisplayLanguage

public Language getHmiDisplayLanguage()

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

Returns:

Language - a Language value representing an enumeration indicating what language the application intends to use for user interaction ( Display)

Since:

SmartDeviceLink 2.0

setHmiDisplayLanguage

public RegisterAppInterfaceResponse setHmiDisplayLanguage(Language hmiDisplayLanguage)

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

Parameters:

hmiDisplayLanguage -

Since:

SmartDeviceLink 2.0

getDisplayCapabilities

@Deprecated
public DisplayCapabilities getDisplayCapabilities()

Deprecated.

Gets getDisplayCapabilities set when application interface is registered.

Returns:

DisplayCapabilities

setDisplayCapabilities

@Deprecated
public RegisterAppInterfaceResponse setDisplayCapabilities(DisplayCapabilities displayCapabilities)

Deprecated.

Sets Display Capabilities

Parameters:

displayCapabilities -

getButtonCapabilities

@Deprecated
public List<ButtonCapabilities> getButtonCapabilities()

Deprecated.

Gets buttonCapabilities set when application interface is registered.

Returns:

buttonCapabilities

setButtonCapabilities

@Deprecated
public RegisterAppInterfaceResponse setButtonCapabilities(List<ButtonCapabilities> buttonCapabilities)

Deprecated.

Sets Button Capabilities

Parameters:

buttonCapabilities -

getSoftButtonCapabilities

@Deprecated
public List<SoftButtonCapabilities> getSoftButtonCapabilities()

Deprecated.

Gets getSoftButtonCapabilities set when application interface is registered.

Returns:

SoftButtonCapabilities

setSoftButtonCapabilities

@Deprecated
public RegisterAppInterfaceResponse setSoftButtonCapabilities(List<SoftButtonCapabilities> softButtonCapabilities)

Deprecated.

Sets softButtonCapabilities

Parameters:

softButtonCapabilities -

getPresetBankCapabilities

@Deprecated
public PresetBankCapabilities getPresetBankCapabilities()

Deprecated.

Gets getPresetBankCapabilities set when application interface is registered.

Returns:

PresetBankCapabilities

setPresetBankCapabilities

@Deprecated
public RegisterAppInterfaceResponse setPresetBankCapabilities(PresetBankCapabilities presetBankCapabilities)

Deprecated.

Sets presetBankCapabilities

Parameters:

presetBankCapabilities -

getHmiZoneCapabilities

public List<HmiZoneCapabilities> getHmiZoneCapabilities()

Gets hmiZoneCapabilities set when application interface is registered.

Returns:

HmiZoneCapabilities

setHmiZoneCapabilities

public RegisterAppInterfaceResponse setHmiZoneCapabilities(List<HmiZoneCapabilities> hmiZoneCapabilities)

Sets hmiZoneCapabilities

Parameters:

hmiZoneCapabilities -

getSpeechCapabilities

public List<SpeechCapabilities> getSpeechCapabilities()

Gets speechCapabilities set when application interface is registered.

Returns:

SpeechCapabilities

setSpeechCapabilities

public RegisterAppInterfaceResponse setSpeechCapabilities(List<SpeechCapabilities> speechCapabilities)

Sets speechCapabilities

Parameters:

speechCapabilities -

getPrerecordedSpeech

public List<PrerecordedSpeech> getPrerecordedSpeech()

setPrerecordedSpeech

public RegisterAppInterfaceResponse setPrerecordedSpeech(List<PrerecordedSpeech> prerecordedSpeech)

getVrCapabilities

public List<VrCapabilities> getVrCapabilities()

Gets vrCapabilities set when application interface is registered.

Returns:

VrCapabilities

setVrCapabilities

public RegisterAppInterfaceResponse setVrCapabilities(List<VrCapabilities> vrCapabilities)

Sets VrCapabilities

Parameters:

vrCapabilities -

getVehicleType

@Deprecated
public VehicleType getVehicleType()

Deprecated. in SmartDeviceLink 7.1.0

Gets getVehicleType set when application interface is registered.

Returns:

vehicleType

setVehicleType

@Deprecated
public RegisterAppInterfaceResponse setVehicleType(VehicleType vehicleType)

Deprecated. in SmartDeviceLink 7.1.0

Sets vehicleType

Parameters:

vehicleType -

getAudioPassThruCapabilities

public List<AudioPassThruCapabilities> getAudioPassThruCapabilities()

Gets AudioPassThruCapabilities set when application interface is registered.

Returns:

AudioPassThruCapabilities

setAudioPassThruCapabilities

public RegisterAppInterfaceResponse setAudioPassThruCapabilities(List<AudioPassThruCapabilities> audioPassThruCapabilities)

Sets AudioPassThruCapabilities

Parameters:

audioPassThruCapabilities -

getPcmStreamingCapabilities

public AudioPassThruCapabilities getPcmStreamingCapabilities()

Gets pcmStreamingCapabilities set when application interface is registered.

Returns:

pcmStreamingCapabilities

setPcmStreamingCapabilities

public RegisterAppInterfaceResponse setPcmStreamingCapabilities(AudioPassThruCapabilities pcmStreamingCapabilities)

Sets pcmStreamingCapabilities

Parameters:

pcmStreamingCapabilities -

setSupportedDiagModes

public RegisterAppInterfaceResponse setSupportedDiagModes(List<Integer> supportedDiagModes)

getSupportedDiagModes

public List<Integer> getSupportedDiagModes()

setHmiCapabilities

public RegisterAppInterfaceResponse setHmiCapabilities(HMICapabilities hmiCapabilities)

getHmiCapabilities

public HMICapabilities getHmiCapabilities()

setSdlVersion

public RegisterAppInterfaceResponse setSdlVersion(String sdlVersion)

getSdlVersion

public String getSdlVersion()

setSystemSoftwareVersion

@Deprecated
public RegisterAppInterfaceResponse setSystemSoftwareVersion(String systemSoftwareVersion)

Deprecated. in SmartDeviceLink 7.1.0

The software version of the connected device.

Parameters:

systemSoftwareVersion - the version of software on the connected device

Returns:

RegisterAppInterface

getSystemSoftwareVersion

@Deprecated
public String getSystemSoftwareVersion()

Deprecated. in SmartDeviceLink 7.1.0

The software version of the connected device.

Returns:

String the version of software on the connected device

setIconResumed

public RegisterAppInterfaceResponse setIconResumed(Boolean iconResumed)

Sets Icon Resumed Boolean

Parameters:

iconResumed - - if param not included, set to false

getIconResumed

public Boolean getIconResumed()

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

Returns:

boolean - true if icon was resumed, false if not