com.smartdevicelink.proxy.rpc

Class ChangeRegistration

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.ChangeRegistration

All Implemented Interfaces:

Cloneable

public class ChangeRegistration
extends RPCRequest

If the app recognizes during the app registration that the SDL HMI language (voice/TTS and/or display) does not match the app language, the app will be able (but does not need) to change this registration with changeRegistration prior to app being brought into focus.

Function Group: Base

HMILevel can by any

Note:

SDL will send the language value confirmed to be supported by HMI via UI.GetCapabilities.

Parameter List

Name	Type	Description	Req.	Notes	Version Available
Language	Language	Requested SDL voice engine (VR+TTS) language registration.	Y		SmartDeviceLink 2.0
hmiDisplayLanguage	Language	Request display language registration.	Y	Minvalue=0; Maxvalue=2000000000	SmartDeviceLink 2.0
appName	String	Request new app name registration	N	maxlength:100	SmartDeviceLink 2.0
ttsName	TTSChunk	Request new ttsName registration	N	minsize:1; maxsize:100	SmartDeviceLink 2.0
ngnMediaScreenAppName	String	Request new app short name registration	N	maxlength: 100	SmartDeviceLink 2.0
vrSynonyms	String	Request new VR synonyms registration	N	maxlength: 40; minsize:1; maxsize:100	SmartDeviceLink 2.0

Response

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

REJECTED

DISALLOWED

Since:

SmartDeviceLink 2.0

See Also:

RegisterAppInterface

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_APP_NAME
static String	KEY_HMI_DISPLAY_LANGUAGE
static String	KEY_LANGUAGE
static String	KEY_NGN_MEDIA_SCREEN_NAME
static String	KEY_TTS_NAME
static String	KEY_VR_SYNONYMS

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

onResponseListener

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
ChangeRegistration() Constructs a new ChangeRegistration object
ChangeRegistration(Hashtable<String,Object> hash) Constructs a new ChangeRegistration object indicated by the Hashtable parameter
ChangeRegistration(Language language, Language hmiDisplayLanguage) Constructs a new ChangeRegistration object

Method Summary

Modifier and Type	Method and Description
String	getAppName() Gets app name
Language	getHmiDisplayLanguage() Gets HMI display language
Language	getLanguage() Gets language
String	getNgnMediaScreenAppName() Gets NGN media screen app name
List<TTSChunk>	getTtsName() Gets the TTS name
List<String>	getVrSynonyms() Gets the List representing the an array of 1-100 elements, each element containing a voice-recognition synonym
ChangeRegistration	setAppName(String appName) Sets app name
ChangeRegistration	setHmiDisplayLanguage(Language hmiDisplayLanguage) Sets HMI display language
ChangeRegistration	setLanguage(Language language) Sets language
ChangeRegistration	setNgnMediaScreenAppName(String ngnAppName) Sets NGN media screen app name
ChangeRegistration	setTtsName(List<TTSChunk> ttsName) Sets the TTS name
ChangeRegistration	setVrSynonyms(List<String> vrSynonyms) Sets a vrSynonyms representing the an array of 1-100 elements, each element containing a voice-recognition synonym

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

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, format, 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_LANGUAGE

public static final String KEY_LANGUAGE

See Also:

Constant Field Values

KEY_HMI_DISPLAY_LANGUAGE

public static final String KEY_HMI_DISPLAY_LANGUAGE

See Also:

Constant Field Values

KEY_APP_NAME

public static final String KEY_APP_NAME

See Also:

Constant Field Values

KEY_TTS_NAME

public static final String KEY_TTS_NAME

See Also:

Constant Field Values

KEY_NGN_MEDIA_SCREEN_NAME

public static final String KEY_NGN_MEDIA_SCREEN_NAME

See Also:

Constant Field Values

KEY_VR_SYNONYMS

public static final String KEY_VR_SYNONYMS

See Also:

Constant Field Values

Constructor Detail

ChangeRegistration

public ChangeRegistration()

Constructs a new ChangeRegistration object

ChangeRegistration

public ChangeRegistration(Hashtable<String,Object> hash)

Constructs a new ChangeRegistration object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

ChangeRegistration

public ChangeRegistration(@NonNull
                          Language language,
                          @NonNull
                          Language hmiDisplayLanguage)

Constructs a new ChangeRegistration object

Parameters:

language - a language value

hmiDisplayLanguage - a Language value

Method Detail

setLanguage

public ChangeRegistration setLanguage(@NonNull
                                      Language language)

Sets language

Parameters:

language - a language value

getLanguage

public Language getLanguage()

Gets language

Returns:

Language -a Language value

setHmiDisplayLanguage

public ChangeRegistration setHmiDisplayLanguage(@NonNull
                                                Language hmiDisplayLanguage)

Sets HMI display language

Parameters:

hmiDisplayLanguage - a Language value

getHmiDisplayLanguage

public Language getHmiDisplayLanguage()

Gets HMI display language

Returns:

Language -a Language value

setAppName

public ChangeRegistration setAppName(String appName)

Sets app name

Parameters:

appName - App name to set

getAppName

public String getAppName()

Gets app name

Returns:

The app name

setNgnMediaScreenAppName

public ChangeRegistration setNgnMediaScreenAppName(String ngnAppName)

Sets NGN media screen app name

Parameters:

ngnAppName - The NGN app name

getNgnMediaScreenAppName

public String getNgnMediaScreenAppName()

Gets NGN media screen app name

Returns:

The NGN app name

setTtsName

public ChangeRegistration setTtsName(List<TTSChunk> ttsName)

Sets the TTS name

Parameters:

ttsName - The TTS name to set

getTtsName

public List<TTSChunk> getTtsName()

Gets the TTS name

Returns:

The TTS name

getVrSynonyms

public List<String> getVrSynonyms()

Gets the List representing the an array of 1-100 elements, each element containing a voice-recognition synonym

Returns:

List -a List value representing the an array of 1-100 elements, each element containing a voice-recognition synonym

setVrSynonyms

public ChangeRegistration setVrSynonyms(List<String> vrSynonyms)

Sets a vrSynonyms representing the an array of 1-100 elements, each element containing a voice-recognition synonym

Parameters:

vrSynonyms - a List value representing the an array of 1-100 elements

Notes:

• Each vr synonym is limited to 40 characters, and there can be 1-100 synonyms in array
• May not be the same (by case insensitive comparison) as the name or any synonym of any currently-registered application