RegisterAppInterface (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.proxy.RPCStruct
- - com.smartdevicelink.proxy.RPCMessage
  - - com.smartdevicelink.proxy.RPCRequest
    - - com.smartdevicelink.proxy.rpc.RegisterAppInterface

All Implemented Interfaces:: Cloneable

public class RegisterAppInterface
extends RPCRequest

Registers the application's interface with SDL®, declaring properties of the registration, including the messaging interface version, the app name, etc. The mobile application must establish its interface registration with SDL® before any other interaction with SDL® can take place. The registration lasts until it is terminated either by the application calling the UnregisterAppInterface method, or by SDL® sending an OnAppInterfaceUnregistered notification, or by loss of the underlying transport connection, or closing of the underlying message transmission protocol RPC session

Until the application receives its first OnHMIStatus Notification, its HMI Status is assumed to be: HMILevel=NONE, AudioStreamingState =NOT_AUDIBLE, SystemContext=MAIN

All SDL® resources which the application creates or uses (e.g. Choice Sets, Command Menu, etc.) are associated with the application's interface registration. Therefore, when the interface registration ends, the SDL® resources associated with the application are disposed of. As a result, even though the application itself may continue to run on its host platform (e.g. mobile device) after the interface registration terminates, the application will not be able to use the SDL® HMI without first establishing a new interface registration and re-creating its required SDL® resources. That is, SDL® resources created by (or on behalf of) an application do not persist beyond the life-span of the interface registration

Resources and settings whose lifespan is tied to the duration of an application's interface registration:

Choice Sets
Command Menus (built by successive calls to AddCommand )
Media clock timer display value
Media clock timer display value
Media clock timer display value

The autoActivateID is used to grant an application the HMILevel and AudioStreamingState it had when it last disconnected

Notes: The autoActivateID parameter, and associated behavior, is currently ignored by SDL®

When first calling this method (i.e. first time within life cycle of mobile app), an autoActivateID should not be included. After successfully registering an interface, an autoActivateID is returned to the mobile application for it to use in subsequent connections. If the connection between SDL® and the mobile application is lost, such as the vehicle is turned off while the application is running, the autoActivateID can then be passed in another call to RegisterAppInterface to re-acquire HMILevel=FULL

If the application intends to stream audio it is important to indicate so via the isMediaApp parameter. When set to true, audio will reliably stream without any configuration required by the user. When not set, audio may stream, depending on what the user might have manually configured as a media source on SDL®

There is no time limit for how long the autoActivateID is "valid" (i.e. would confer focus and opt-in)

HMILevel is not defined before registering

Parameter List

Name	Type	Description	Reg.	Notes	Version
MsgVersion	MsgVersion	Declares what version of the SDL interface the application expects to use with SDL	Y	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.	SmartDeviceLink 1.0
appName	String	The mobile application's name. This name is displayed in the SDL Mobile Applications menu. It also serves as the unique identifier of the application for SDL .	Y	Must be 1-100 characters in length. Must consist of following characters: May not be the same (by case insensitive comparison) as the name or any synonym of any currently registered application.	SmartDeviceLink 1.0
ttsName	TTSChunk	TTS string for VR recognition of the mobile application name. Meant to overcome any failing on speech engine in properly pronouncing / understanding app name.	N	Size must be 1-100 Needs to be unique over all applications. May not be empty. May not start with a new line character.	SmartDeviceLink 2.0
ngnMediaScreenAppName	String	Provides an abbreviated version of the app name (if necessary) that will be displayed on the NGN media screen.	N	- Must be 1-5 characters. If not provided, value will be derived from appName truncated to 5 characters.	SmartDeviceLink 1.0
vrSynonyms	String	An array of 1-100 elements, each element containing a voice-recognition synonym by which this app can be called when being addressed in the mobile applications menu.	N	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.	SmartDeviceLink 1.0
isMediaApplication	Boolean	Indicates that the application will be streaming audio to SDL (via A2DP) that is audible outside of the BT media source.	Y		SmartDeviceLink 1.0
languageDesired	Language	An enumeration indicating what language the application intends to use for user interaction (Display, TTS and VR).	Y	If the language indicated does not match the active language on SDL, the interface registration will be rejected.If the user changes the SDL language while this interface registration is active, the interface registration will be terminated.	SmartDeviceLink 1.0
hmiDisplayLanguageDesired	Language	An enumeration indicating what language the application intends to use for user interaction ( Display).	Y		SmartDeviceLink 2.0
appHMIType	AppHMIType	List of all applicable app types stating which classifications to be given to the app.e.g. for platforms , like GEN2, this will determine which "corner(s)" the app can populate	N	Array Minsize: 1; Array Maxsize: 100	SmartDeviceLink 2.0
hashID	String	ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles).This registered data (commands, submenus, choice sets, etc.) can be reestablished without needing to explicitly reregister each piece. If omitted, then the previous state of an app's commands, etc. will not be restored.When sending hashID, all RegisterAppInterface parameters should still be provided (e.g. ttsName, etc.).	N	maxLength:100	SmartDeviceLink 2.3.1
appInfo	AppInfo	See AppInfo.	N		@since SmartDeviceLink 4.2.0
deviceInfo	DeviceInfo	Various information about connecting device.	N		SmartDeviceLink 2.3.1
appID	String	ID used to validate app with policy table entries	Y	maxLength: 100	SmartDeviceLink 2.0
fullAppID	String	ID used to validate app with policy table entries	N	Maxlength: 100	SmartDeviceLink 5.0
hmiCapabilities	HMICapabilities	Specifies the HMI capabilities.	N		SmartDeviceLink 2.3.2.2
sdlVersion	String	The SmartDeviceLink version.	N	Maxlength: 100	SmartDeviceLink 2.3.2.2
systemSoftwareVersion	String	The software version of the system that implements the SmartDeviceLink core.	N	Maxlength: 100	SmartDeviceLink 2.3.2.2
dayColorScheme	TemplateColorScheme	The color scheme that is used for day.	N		SmartDeviceLink 5.0
nightColorScheme	TemplateColorScheme	The color scheme that is used for night.	N		SmartDeviceLink 5.0

Since:: SmartDeviceLink 1.0
See Also:: UnregisterAppInterface, OnAppInterfaceUnregistered

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_APP_HMI_TYPE`
`static String`	`KEY_APP_ID`
`static String`	`KEY_APP_INFO`
`static String`	`KEY_APP_NAME`
`static String`	`KEY_DAY_COLOR_SCHEME`
`static String`	`KEY_DEVICE_INFO`
`static String`	`KEY_FULL_APP_ID`
`static String`	`KEY_HASH_ID`
`static String`	`KEY_HMI_DISPLAY_LANGUAGE_DESIRED`
`static String`	`KEY_IS_MEDIA_APPLICATION`
`static String`	`KEY_LANGUAGE_DESIRED`
`static String`	`KEY_NGN_MEDIA_SCREEN_APP_NAME`
`static String`	`KEY_NIGHT_COLOR_SCHEME`
`static String`	`KEY_SDL_MSG_VERSION`
`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
`RegisterAppInterface()` Constructs a new RegisterAppInterface object
`RegisterAppInterface(Hashtable<String,Object> hash)` Constructs a new RegisterAppInterface object indicated by the Hashtable parameter
`RegisterAppInterface(SdlMsgVersion syncMsgVersion, String appName, Boolean isMediaApplication, Language languageDesired, Language hmiDisplayLanguageDesired, String fullAppID)` Constructs a new RegisterAppInterface object

Method Summary

All Methods Instance Methods Concrete Methods
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<AppHMIType>`	`getAppHMIType()` Gets a list of all applicable app types stating which classifications to be given to the app.e.g.
`String`	`getAppID()` Gets the unique ID, which an app will be given when approved
`AppInfo`	`getAppInfo()` Gets the appInfo.
`String`	`getAppName()` Gets Mobile Application's Name
`TemplateColorScheme`	`getDayColorScheme()` Gets the color scheme that is currently used for day
`DeviceInfo`	`getDeviceInfo()`
`String`	`getFullAppID()` Gets the unique ID, which an app will be given when approved
`String`	`getHashID()`
`Language`	`getHmiDisplayLanguageDesired()` Gets an enumeration indicating what language the application intends to use for user interaction ( Display)
`Boolean`	`getIsMediaApplication()` Gets a Boolean representing MediaApplication
`Language`	`getLanguageDesired()` Gets a Language enumeration indicating what language the application intends to use for user interaction (Display, TTS and VR)
`String`	`getNgnMediaScreenAppName()` Gets a String representing an abbreviated version of the mobile application's name (if necessary) that will be displayed on the NGN media screen
`TemplateColorScheme`	`getNightColorScheme()` Gets the color scheme that is currently used for night
`SdlMsgVersion`	`getSdlMsgVersion()` Gets the version of the SDL® SmartDeviceLink interface
`List<TTSChunk>`	`getTtsName()` Gets TTS string for VR recognition of the mobile application name
`List<String>`	`getVrSynonyms()` Gets the List representing the an array of 1-100 elements, each element containing a voice-recognition synonym
`RegisterAppInterface`	`setAppHMIType(List<AppHMIType> appHMIType)` Sets a a list of all applicable app types stating which classifications to be given to the app.
`RegisterAppInterface`	`setAppID(String appID)` Sets a unique ID, which an app will be given when approved
`RegisterAppInterface`	`setAppInfo(AppInfo appInfo)` Sets the appInfo.
`RegisterAppInterface`	`setAppName(String appName)` Sets Mobile Application's Name, This name is displayed in the SDL® Mobile Applications menu.
`RegisterAppInterface`	`setDayColorScheme(TemplateColorScheme templateColorScheme)` Sets the color scheme that is intended to be used for day
`RegisterAppInterface`	`setDeviceInfo(DeviceInfo deviceInfo)`
`RegisterAppInterface`	`setFullAppID(String fullAppID)` Sets a unique ID, which an app will be given when approved Note: this will automatically parse the fullAppID into the smaller appId and set the appId value as well
`RegisterAppInterface`	`setHashID(String hashID)`
`RegisterAppInterface`	`setHmiDisplayLanguageDesired(Language hmiDisplayLanguageDesired)` Sets an enumeration indicating what language the application intends to use for user interaction ( Display)
`RegisterAppInterface`	`setIsMediaApplication(Boolean isMediaApplication)` Sets a Boolean to indicate a mobile application that is a media application or not
`RegisterAppInterface`	`setLanguageDesired(Language languageDesired)` Sets an enumeration indicating what language the application intends to use for user interaction (Display, TTS and VR)
`RegisterAppInterface`	`setNgnMediaScreenAppName(String ngnMediaScreenAppName)` Sets a String representing an abbreviated version of the mobile application's name (if necessary) that will be displayed on the NGN media screen
`RegisterAppInterface`	`setNightColorScheme(TemplateColorScheme templateColorScheme)` Sets the color scheme that is intended to be used for night
`RegisterAppInterface`	`setSdlMsgVersion(SdlMsgVersion sdlMsgVersion)` Sets the version of the SDL® SmartDeviceLink interface
`RegisterAppInterface`	`setTtsName(List<TTSChunk> ttsName)`
`RegisterAppInterface`	`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, 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_TTS_NAME
```
public static final String KEY_TTS_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_HMI_DISPLAY_LANGUAGE_DESIRED
```
public static final String KEY_HMI_DISPLAY_LANGUAGE_DESIRED
```
    See Also:
    
    Constant Field Values
  - KEY_APP_HMI_TYPE
```
public static final String KEY_APP_HMI_TYPE
```
    See Also:
    
    Constant Field Values
  - KEY_APP_ID
```
public static final String KEY_APP_ID
```
    See Also:
    
    Constant Field Values
  - KEY_FULL_APP_ID
```
public static final String KEY_FULL_APP_ID
```
    See Also:
    
    Constant Field Values
  - KEY_LANGUAGE_DESIRED
```
public static final String KEY_LANGUAGE_DESIRED
```
    See Also:
    
    Constant Field Values
  - KEY_DEVICE_INFO
```
public static final String KEY_DEVICE_INFO
```
    See Also:
    
    Constant Field Values
  - KEY_APP_NAME
```
public static final String KEY_APP_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_NGN_MEDIA_SCREEN_APP_NAME
```
public static final String KEY_NGN_MEDIA_SCREEN_APP_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_IS_MEDIA_APPLICATION
```
public static final String KEY_IS_MEDIA_APPLICATION
```
    See Also:
    
    Constant Field Values
  - KEY_VR_SYNONYMS
```
public static final String KEY_VR_SYNONYMS
```
    See Also:
    
    Constant Field Values
  - KEY_SDL_MSG_VERSION
```
public static final String KEY_SDL_MSG_VERSION
```
    See Also:
    
    Constant Field Values
  - KEY_HASH_ID
```
public static final String KEY_HASH_ID
```
    See Also:
    
    Constant Field Values
  - KEY_APP_INFO
```
public static final String KEY_APP_INFO
```
    Since:
    
    SmartDeviceLink 4.2.0
    
    See Also:
    
    Constant Field Values
  - KEY_DAY_COLOR_SCHEME
```
public static final String KEY_DAY_COLOR_SCHEME
```
    See Also:
    
    Constant Field Values
  - KEY_NIGHT_COLOR_SCHEME
```
public static final String KEY_NIGHT_COLOR_SCHEME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RegisterAppInterface
```
public RegisterAppInterface()
```
    Constructs a new RegisterAppInterface object
  - RegisterAppInterface
```
public RegisterAppInterface(Hashtable<String,Object> hash)
```
    Constructs a new RegisterAppInterface object indicated by the Hashtable parameter
    
    Parameters:
    
    hash - The Hashtable to use
  - RegisterAppInterface
```
public RegisterAppInterface(@NonNull
                            SdlMsgVersion syncMsgVersion,
                            @NonNull
                            String appName,
                            @NonNull
                            Boolean isMediaApplication,
                            @NonNull
                            Language languageDesired,
                            @NonNull
                            Language hmiDisplayLanguageDesired,
                            @NonNull
                            String fullAppID)
```
    Constructs a new RegisterAppInterface object
    Parameters:
    
    syncMsgVersion - 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®
    appName - a String value representing the Mobile Application's Name
    Notes:
    
    Must be 1-100 characters in length
    
    May not be the same (by case insensitive comparison) as the name or any synonym of any currently-registered application
    isMediaApplication - a Boolean value
    
    languageDesired - a Language Enumeration
    
    hmiDisplayLanguageDesired - the requested language to be used on the HMI/Display
    
    fullAppID - a String value representing a unique ID, which an app will be given when approved
    Notes: maxLength = 100
- Method Detail
  - 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 RegisterAppInterface setSdlMsgVersion(@NonNull
                                             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®
  - getDeviceInfo
```
public DeviceInfo getDeviceInfo()
```
  - setDeviceInfo
```
public RegisterAppInterface setDeviceInfo(DeviceInfo deviceInfo)
```
  - getAppName
```
public String getAppName()
```
    Gets Mobile Application's Name
    
    Returns:
    
    String -a String representing the Mobile Application's Name
  - setAppName
```
public RegisterAppInterface setAppName(@NonNull
                                       String appName)
```
    Sets Mobile Application's Name, This name is displayed in the SDL® Mobile Applications menu. It also serves as the unique identifier of the application for SmartDeviceLink
    Parameters:
    appName - a String value representing the Mobile Application's Name
    Notes:
    
    Must be 1-100 characters in length
    
    May not be the same (by case insensitive comparison) as the name or any synonym of any currently-registered application
  - getTtsName
```
public List<TTSChunk> getTtsName()
```
    Gets TTS string for VR recognition of the mobile application name
    
    Returns:
    
    List -List value representing the TTS string
    
    Since:
    
    SmartDeviceLink 2.0
  - setTtsName
```
public RegisterAppInterface setTtsName(List<TTSChunk> ttsName)
```
    Parameters:
    ttsName - a List value representing the TTS Name
    Notes:
    
    Size must be 1-100
    
    Needs to be unique over all applications
    
    May not be empty
    
    May not start with a new line character
    
    May not interfere with any name or synonym of previously registered applications and the following list of words
    
    Needs to be unique over all applications. Applications with the same name will be rejected
    Since:
    
    SmartDeviceLink 2.0
  - getNgnMediaScreenAppName
```
public String getNgnMediaScreenAppName()
```
    Gets a String representing an abbreviated version of the mobile application's name (if necessary) that will be displayed on the NGN media screen
    
    Returns:
    
    String -a String value representing an abbreviated version of the mobile application's name
  - setNgnMediaScreenAppName
```
public RegisterAppInterface setNgnMediaScreenAppName(String ngnMediaScreenAppName)
```
    Sets a String representing an abbreviated version of the mobile application's name (if necessary) that will be displayed on the NGN media screen
    Parameters:
    ngnMediaScreenAppName - a String value representing an abbreviated version of the mobile application's name
    Notes:
    
    Must be 1-5 characters
    
    If not provided, value will be derived from appName truncated to 5 characters
  - 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 RegisterAppInterface 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
  - getIsMediaApplication
```
public Boolean getIsMediaApplication()
```
    Gets a Boolean representing MediaApplication
    
    Returns:
    
    Boolean -a Boolean value representing a mobile application that is a media application or not
  - setIsMediaApplication
```
public RegisterAppInterface setIsMediaApplication(@NonNull
                                                  Boolean isMediaApplication)
```
    Sets a Boolean to indicate a mobile application that is a media application or not
    
    Parameters:
    
    isMediaApplication - a Boolean value
  - getLanguageDesired
```
public Language getLanguageDesired()
```
    Gets a Language enumeration indicating what language the application intends to use for user interaction (Display, TTS and VR)
    
    Returns:
    
    Enumeration -a language enumeration
  - setLanguageDesired
```
public RegisterAppInterface setLanguageDesired(@NonNull
                                               Language languageDesired)
```
    Sets an enumeration indicating what language the application intends to use for user interaction (Display, TTS and VR)
    
    Parameters:
    
    languageDesired - a Language Enumeration
  - getHmiDisplayLanguageDesired
```
public Language getHmiDisplayLanguageDesired()
```
    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
  - setHmiDisplayLanguageDesired
```
public RegisterAppInterface setHmiDisplayLanguageDesired(@NonNull
                                                         Language hmiDisplayLanguageDesired)
```
    Sets an enumeration indicating what language the application intends to use for user interaction ( Display)
    
    Parameters:
    
    hmiDisplayLanguageDesired - the requested language to be used on the HMI/Display
    
    Since:
    
    SmartDeviceLink 2.0
  - getAppHMIType
```
public List<AppHMIType> getAppHMIType()
```
    Gets a list of all applicable app types stating which classifications to be given to the app.e.g. for platforms , like GEN2, this will determine which "corner(s)" the app can populate
    
    Returns:
    
    List - a List value representing a list of all applicable app types stating which classifications to be given to the app
    
    Since:
    
    SmartDeviceLink 2.0
  - setAppHMIType
```
public RegisterAppInterface setAppHMIType(List<AppHMIType> appHMIType)
```
    Sets a a list of all applicable app types stating which classifications to be given to the app. e.g. for platforms , like GEN2, this will determine which "corner(s)" the app can populate
    Parameters:
    appHMIType - a List
    Notes:
    
    Array Minsize: = 1
    
    Array Maxsize = 100
    Since:
    
    SmartDeviceLink 2.0
  - getHashID
```
public String getHashID()
```
  - setHashID
```
public RegisterAppInterface setHashID(String hashID)
```
  - getAppInfo
```
public AppInfo getAppInfo()
```
    Gets the appInfo.
    
    Returns:
    
    AppInfo See AppInfo.
    
    Since:
    
    SmartDeviceLink 4.2.0
  - setAppInfo
```
public RegisterAppInterface setAppInfo(AppInfo appInfo)
```
    Sets the appInfo.
    
    Parameters:
    
    appInfo - See AppInfo.
    
    Since:
    
    SmartDeviceLink 4.2.0
  - getAppID
```
public String getAppID()
```
    Gets the unique ID, which an app will be given when approved
    
    Returns:
    
    String - a String value representing the unique ID, which an app will be given when approved
    
    Since:
    
    SmartDeviceLink 2.0
  - setAppID
```
public RegisterAppInterface setAppID(@NonNull
                                     String appID)
```
    Sets a unique ID, which an app will be given when approved
    
    Parameters:
    
    appID - a String value representing a unique ID, which an app will be given when approved
    Notes: maxLength = 100
    
    Since:
    
    SmartDeviceLink 2.0
  - getFullAppID
```
public String getFullAppID()
```
    Gets the unique ID, which an app will be given when approved
    
    Returns:
    
    String - a String value representing the unique ID, which an app will be given when approved
    
    Since:
    
    SmartDeviceLink 5.0
  - setFullAppID
```
public RegisterAppInterface setFullAppID(String fullAppID)
```
    Sets a unique ID, which an app will be given when approved
    Note: this will automatically parse the fullAppID into the smaller appId and set the appId value as well
    
    Parameters:
    
    fullAppID - a String value representing a unique ID, which an app will be given when approved
    Notes: maxLength = 100
    
    Since:
    
    SmartDeviceLink 5.0
  - 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
  - getDayColorScheme
```
public TemplateColorScheme getDayColorScheme()
```
    Gets the color scheme that is currently used for day
    
    Returns:
    
    TemplateColorScheme - a TemplateColorScheme object representing the colors that are used for day color scheme
    
    Since:
    
    SmartDeviceLink 5.0
  - setDayColorScheme
```
public RegisterAppInterface setDayColorScheme(TemplateColorScheme templateColorScheme)
```
    Sets the color scheme that is intended to be used for day
    
    Parameters:
    
    templateColorScheme - a TemplateColorScheme object representing the colors that will be used for day color scheme
    
    Since:
    
    SmartDeviceLink 5.0
  - getNightColorScheme
```
public TemplateColorScheme getNightColorScheme()
```
    Gets the color scheme that is currently used for night
    
    Returns:
    
    TemplateColorScheme - a TemplateColorScheme object representing the colors that are used for night color scheme
    
    Since:
    
    SmartDeviceLink 5.0
  - setNightColorScheme
```
public RegisterAppInterface setNightColorScheme(TemplateColorScheme templateColorScheme)
```
    Sets the color scheme that is intended to be used for night
    
    Parameters:
    
    templateColorScheme - a TemplateColorScheme object representing the colors that will be used for night color scheme
    
    Since:
    
    SmartDeviceLink 5.0

Class RegisterAppInterface

Field Summary

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

Constructor Summary

Method Summary

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

Methods inherited from class java.lang.Object

Field Detail

KEY_TTS_NAME

KEY_HMI_DISPLAY_LANGUAGE_DESIRED

KEY_APP_HMI_TYPE

KEY_APP_ID

KEY_FULL_APP_ID

KEY_LANGUAGE_DESIRED

KEY_DEVICE_INFO

KEY_APP_NAME

KEY_NGN_MEDIA_SCREEN_APP_NAME

KEY_IS_MEDIA_APPLICATION

KEY_VR_SYNONYMS

KEY_SDL_MSG_VERSION

KEY_HASH_ID

KEY_APP_INFO

KEY_DAY_COLOR_SCHEME

KEY_NIGHT_COLOR_SCHEME

Constructor Detail

RegisterAppInterface

RegisterAppInterface

RegisterAppInterface

Method Detail

getSdlMsgVersion

setSdlMsgVersion

getDeviceInfo

setDeviceInfo

getAppName

setAppName

getTtsName

setTtsName

getNgnMediaScreenAppName

setNgnMediaScreenAppName

getVrSynonyms

setVrSynonyms

getIsMediaApplication

setIsMediaApplication

getLanguageDesired

setLanguageDesired

getHmiDisplayLanguageDesired

setHmiDisplayLanguageDesired

getAppHMIType

setAppHMIType

getHashID

setHashID

getAppInfo

setAppInfo

getAppID

setAppID

getFullAppID

setFullAppID

format

getDayColorScheme

setDayColorScheme

getNightColorScheme

setNightColorScheme