diff options
| author | Joey Grover <joeygrover@gmail.com> | 2016-09-01 10:37:21 -0400 |
|---|---|---|
| committer | Joey Grover <joeygrover@gmail.com> | 2016-09-01 10:37:21 -0400 |
| commit | 36adc82a2dce6bd104c6c0abb831c49d77843377 (patch) | |
| tree | 16400ec3f7f5b258d312efa26bfc69ba47882bb6 | |
| parent | d24590046284474d746648ce8a2defc52a0dea28 (diff) | |
| parent | 9f3dbae6a86cc7355342c6af9981f5bf95c03152 (diff) | |
| download | sdl_android-feature/android_studio.tar.gz | |
Merge branch 'develop' of https://github.com/smartdevicelink/sdl_android into feature/android_studiofeature/android_studio
200 files changed, 6677 insertions, 1633 deletions
diff --git a/HelloSdl/.settings/org.eclipse.jdt.core.prefs b/HelloSdl/.settings/org.eclipse.jdt.core.prefs deleted file mode 100644 index b080d2ddc..000000000 --- a/HelloSdl/.settings/org.eclipse.jdt.core.prefs +++ /dev/null @@ -1,4 +0,0 @@ -eclipse.preferences.version=1 -org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 -org.eclipse.jdt.core.compiler.compliance=1.6 -org.eclipse.jdt.core.compiler.source=1.6 diff --git a/HelloSdl/AndroidManifest.xml b/HelloSdl/AndroidManifest.xml deleted file mode 100644 index d15dbe2a6..000000000 --- a/HelloSdl/AndroidManifest.xml +++ /dev/null @@ -1,50 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<manifest xmlns:android="http://schemas.android.com/apk/res/android" - package="com.hellosdl" - android:versionCode="1" - android:versionName="1.0" > - - <uses-sdk - android:minSdkVersion="8" - android:targetSdkVersion="19" /> - - <uses-permission android:name="android.permission.BLUETOOTH" /> - <uses-permission android:name="android.permission.INTERNET" /> - <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> - - <application - android:allowBackup="true" - android:icon="@drawable/ic_launcher" - android:label="@string/app_name" - android:theme="@style/AppTheme" > - <activity - android:name=".MainActivity" - android:label="@string/app_name" > - <intent-filter> - <action android:name="android.intent.action.MAIN" /> - - <category android:name="android.intent.category.LAUNCHER" /> - </intent-filter> - </activity> - - - <service android:name=".sdl.SdlService" ></service> - - <service android:name=".sdl.SdlRouterService" - android:exported="true" - android:process="com.smartdevicelink.router"></service> - - - <receiver android:name=".sdl.SdlReceiver" android:enabled="true" > - <intent-filter> - <action android:name="android.intent.action.BOOT_COMPLETED" /> - <action android:name="android.bluetooth.device.action.ACL_CONNECTED"/> - <action android:name="android.bluetooth.adapter.action.STATE_CHANGED" /> - <action android:name = "sdl.router.startservice"/> - </intent-filter> - </receiver> - - - </application> - -</manifest> diff --git a/HelloSdl/ic_launcher-web.png b/HelloSdl/ic_launcher-web.png Binary files differdeleted file mode 100644 index 3e493438c..000000000 --- a/HelloSdl/ic_launcher-web.png +++ /dev/null diff --git a/HelloSdl/libs/android-support-v4.jar b/HelloSdl/libs/android-support-v4.jar Binary files differdeleted file mode 100644 index 4ebdaa9ed..000000000 --- a/HelloSdl/libs/android-support-v4.jar +++ /dev/null diff --git a/HelloSdl/lint.xml b/HelloSdl/lint.xml deleted file mode 100644 index ee0eead5b..000000000 --- a/HelloSdl/lint.xml +++ /dev/null @@ -1,3 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<lint> -</lint>
\ No newline at end of file diff --git a/HelloSdl/proguard-project.txt b/HelloSdl/proguard-project.txt deleted file mode 100644 index f2fe1559a..000000000 --- a/HelloSdl/proguard-project.txt +++ /dev/null @@ -1,20 +0,0 @@ -# To enable ProGuard in your project, edit project.properties -# to define the proguard.config property as described in that file. -# -# Add project specific ProGuard rules here. -# By default, the flags in this file are appended to flags specified -# in ${sdk.dir}/tools/proguard/proguard-android.txt -# You can edit the include path and order by changing the ProGuard -# include property in project.properties. -# -# For more details, see -# http://developer.android.com/guide/developing/tools/proguard.html - -# Add any project specific keep options here: - -# If your project uses WebView with JS, uncomment the following -# and specify the fully qualified class name to the JavaScript interface -# class: -#-keepclassmembers class fqcn.of.javascript.interface.for.webview { -# public *; -#} diff --git a/HelloSdl/project.properties b/HelloSdl/project.properties deleted file mode 100644 index f76c1b9a4..000000000 --- a/HelloSdl/project.properties +++ /dev/null @@ -1,15 +0,0 @@ -# This file is automatically generated by Android Tools. -# Do not modify this file -- YOUR CHANGES WILL BE ERASED! -# -# This file must be checked in Version Control Systems. -# -# To customize properties used by the Ant build system edit -# "ant.properties", and override values to adapt the script to your -# project structure. -# -# To enable ProGuard to shrink and obfuscate your code, uncomment this (available properties: sdk.dir, user.home): -#proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt:proguard-project.txt - -# Project target. -target=android-19 -android.library.reference.1=../sdl_android_lib diff --git a/HelloSdl/res/drawable-hdpi/ic_launcher.png b/HelloSdl/res/drawable-hdpi/ic_launcher.png Binary files differdeleted file mode 100644 index 903e3d12d..000000000 --- a/HelloSdl/res/drawable-hdpi/ic_launcher.png +++ /dev/null diff --git a/HelloSdl/res/drawable-mdpi/ic_launcher.png b/HelloSdl/res/drawable-mdpi/ic_launcher.png Binary files differdeleted file mode 100644 index 8415d3068..000000000 --- a/HelloSdl/res/drawable-mdpi/ic_launcher.png +++ /dev/null diff --git a/HelloSdl/res/drawable-xhdpi/ic_launcher.png b/HelloSdl/res/drawable-xhdpi/ic_launcher.png Binary files differdeleted file mode 100644 index 962976da1..000000000 --- a/HelloSdl/res/drawable-xhdpi/ic_launcher.png +++ /dev/null diff --git a/HelloSdl/res/drawable-xxhdpi/ic_launcher.png b/HelloSdl/res/drawable-xxhdpi/ic_launcher.png Binary files differdeleted file mode 100644 index f4c378997..000000000 --- a/HelloSdl/res/drawable-xxhdpi/ic_launcher.png +++ /dev/null diff --git a/HelloSdl/res/layout/activity_main.xml b/HelloSdl/res/layout/activity_main.xml deleted file mode 100644 index 5056c3b98..000000000 --- a/HelloSdl/res/layout/activity_main.xml +++ /dev/null @@ -1,16 +0,0 @@ -<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android" - xmlns:tools="http://schemas.android.com/tools" - android:layout_width="match_parent" - android:layout_height="match_parent" - android:paddingBottom="@dimen/activity_vertical_margin" - android:paddingLeft="@dimen/activity_horizontal_margin" - android:paddingRight="@dimen/activity_horizontal_margin" - android:paddingTop="@dimen/activity_vertical_margin" - tools:context="com.hellosdl.MainActivity" > - - <TextView - android:layout_width="wrap_content" - android:layout_height="wrap_content" - android:text="@string/hello_world" /> - -</RelativeLayout> diff --git a/HelloSdl/res/menu/main.xml b/HelloSdl/res/menu/main.xml deleted file mode 100644 index e3df24bab..000000000 --- a/HelloSdl/res/menu/main.xml +++ /dev/null @@ -1,11 +0,0 @@ -<menu xmlns:android="http://schemas.android.com/apk/res/android" - xmlns:app="http://schemas.android.com/apk/res-auto" - xmlns:tools="http://schemas.android.com/tools" - tools:context="com.hellosdl.MainActivity" > - - <item - android:id="@+id/action_settings" - android:orderInCategory="100" - android:title="@string/action_settings"/> - -</menu> diff --git a/HelloSdl/res/values-w820dp/dimens.xml b/HelloSdl/res/values-w820dp/dimens.xml deleted file mode 100644 index f3e70203b..000000000 --- a/HelloSdl/res/values-w820dp/dimens.xml +++ /dev/null @@ -1,10 +0,0 @@ -<resources> - - <!-- - Example customization of dimensions originally defined in res/values/dimens.xml - (such as screen margins) for screens with more than 820dp of available width. This - would include 7" and 10" devices in landscape (~960dp and ~1280dp respectively). - --> - <dimen name="activity_horizontal_margin">64dp</dimen> - -</resources> diff --git a/HelloSdl/res/values/dimens.xml b/HelloSdl/res/values/dimens.xml deleted file mode 100644 index 55c1e5908..000000000 --- a/HelloSdl/res/values/dimens.xml +++ /dev/null @@ -1,7 +0,0 @@ -<resources> - - <!-- Default screen margins, per the Android Design guidelines. --> - <dimen name="activity_horizontal_margin">16dp</dimen> - <dimen name="activity_vertical_margin">16dp</dimen> - -</resources> diff --git a/HelloSdl/res/values/strings.xml b/HelloSdl/res/values/strings.xml deleted file mode 100644 index a7f78e961..000000000 --- a/HelloSdl/res/values/strings.xml +++ /dev/null @@ -1,8 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<resources> - - <string name="app_name">HelloSdl</string> - <string name="hello_world">Hello Car!</string> - <string name="action_settings">Settings</string> - -</resources> diff --git a/HelloSdl/res/values/styles.xml b/HelloSdl/res/values/styles.xml deleted file mode 100644 index 4d175139d..000000000 --- a/HelloSdl/res/values/styles.xml +++ /dev/null @@ -1,20 +0,0 @@ -<resources> - - <!-- - Base application theme, dependent on API level. This theme is replaced - by AppBaseTheme from res/values-vXX/styles.xml on newer devices. - --> - <style name="AppBaseTheme"> - <!-- - Theme customizations available in newer API levels can go in - res/values-vXX/styles.xml, while customizations related to - backward-compatibility can go here. - --> - </style> - - <!-- Application theme. --> - <style name="AppTheme" parent="AppBaseTheme"> - <!-- All customizations that are NOT specific to a particular API-level can go here. --> - </style> - -</resources> diff --git a/HelloSdl/src/com/hellosdl/MainActivity.java b/HelloSdl/src/com/hellosdl/MainActivity.java deleted file mode 100644 index da6b8ecaf..000000000 --- a/HelloSdl/src/com/hellosdl/MainActivity.java +++ /dev/null @@ -1,42 +0,0 @@ -package com.hellosdl; - -import com.hellosdl.sdl.SdlReceiver; -import com.hellosdl.sdl.SdlService; - -import android.app.Activity; -import android.content.Intent; -import android.os.Bundle; -import android.view.Menu; -import android.view.MenuItem; - -public class MainActivity extends Activity { - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - setContentView(R.layout.activity_main); - if(SdlReceiver.isTransportConnected(getBaseContext())){ - Intent startIntent = new Intent(getBaseContext(), SdlService.class); - startService(startIntent); - } - } - - @Override - public boolean onCreateOptionsMenu(Menu menu) { - // Inflate the menu; this adds items to the action bar if it is present. - getMenuInflater().inflate(R.menu.main, menu); - return true; - } - - @Override - public boolean onOptionsItemSelected(MenuItem item) { - // Handle action bar item clicks here. The action bar will - // automatically handle clicks on the Home/Up button, so long - // as you specify a parent activity in AndroidManifest.xml. - int id = item.getItemId(); - if (id == R.id.action_settings) { - return true; - } - return super.onOptionsItemSelected(item); - } -} diff --git a/HelloSdl/src/com/hellosdl/sdl/SdlReceiver.java b/HelloSdl/src/com/hellosdl/sdl/SdlReceiver.java deleted file mode 100644 index 2162516f5..000000000 --- a/HelloSdl/src/com/hellosdl/sdl/SdlReceiver.java +++ /dev/null @@ -1,24 +0,0 @@ -package com.hellosdl.sdl; - - - -import android.content.Context; -import android.content.Intent; -import android.util.Log; - - -public class SdlReceiver extends com.smartdevicelink.transport.SdlBroadcastReceiver { - private static final String TAG = "BCast Receiver"; - - @Override - public Class defineLocalSdlRouterClass() { - return SdlRouterService.class; - } - - @Override - public void onSdlEnabled(Context context, Intent intent) { - Log.e(TAG, "SDL Enabled"); - intent.setClass(context, SdlService.class); - context.startService(intent); - } -} diff --git a/HelloSdl/src/com/hellosdl/sdl/SdlRouterService.java b/HelloSdl/src/com/hellosdl/sdl/SdlRouterService.java deleted file mode 100644 index b80d30c4e..000000000 --- a/HelloSdl/src/com/hellosdl/sdl/SdlRouterService.java +++ /dev/null @@ -1,8 +0,0 @@ -package com.hellosdl.sdl; - - -public class SdlRouterService extends com.smartdevicelink.transport.SdlRouterService { - - - -} diff --git a/HelloSdl/src/com/hellosdl/sdl/SdlService.java b/HelloSdl/src/com/hellosdl/sdl/SdlService.java deleted file mode 100644 index eba5bc780..000000000 --- a/HelloSdl/src/com/hellosdl/sdl/SdlService.java +++ /dev/null @@ -1,688 +0,0 @@ -package com.hellosdl.sdl; - - -import java.io.ByteArrayOutputStream; -import java.io.IOException; -import java.io.InputStream; - -import android.app.Service; -import android.content.Intent; -import android.os.IBinder; -import android.util.Log; - -import com.hellosdl.MainActivity; -import com.hellosdl.R; -import com.smartdevicelink.exception.SdlException; -import com.smartdevicelink.proxy.SdlProxyALM; -import com.smartdevicelink.proxy.callbacks.OnServiceEnded; -import com.smartdevicelink.proxy.callbacks.OnServiceNACKed; -import com.smartdevicelink.proxy.interfaces.IProxyListenerALM; -import com.smartdevicelink.proxy.rpc.AddCommandResponse; -import com.smartdevicelink.proxy.rpc.AddSubMenuResponse; -import com.smartdevicelink.proxy.rpc.AlertManeuverResponse; -import com.smartdevicelink.proxy.rpc.AlertResponse; -import com.smartdevicelink.proxy.rpc.ChangeRegistrationResponse; -import com.smartdevicelink.proxy.rpc.CreateInteractionChoiceSetResponse; -import com.smartdevicelink.proxy.rpc.DeleteCommandResponse; -import com.smartdevicelink.proxy.rpc.DeleteFileResponse; -import com.smartdevicelink.proxy.rpc.DeleteInteractionChoiceSetResponse; -import com.smartdevicelink.proxy.rpc.DeleteSubMenuResponse; -import com.smartdevicelink.proxy.rpc.DiagnosticMessageResponse; -import com.smartdevicelink.proxy.rpc.DialNumberResponse; -import com.smartdevicelink.proxy.rpc.EndAudioPassThruResponse; -import com.smartdevicelink.proxy.rpc.GenericResponse; -import com.smartdevicelink.proxy.rpc.GetDTCsResponse; -import com.smartdevicelink.proxy.rpc.GetVehicleDataResponse; -import com.smartdevicelink.proxy.rpc.ListFilesResponse; -import com.smartdevicelink.proxy.rpc.OnAudioPassThru; -import com.smartdevicelink.proxy.rpc.OnButtonEvent; -import com.smartdevicelink.proxy.rpc.OnButtonPress; -import com.smartdevicelink.proxy.rpc.OnCommand; -import com.smartdevicelink.proxy.rpc.OnDriverDistraction; -import com.smartdevicelink.proxy.rpc.OnHMIStatus; -import com.smartdevicelink.proxy.rpc.OnHashChange; -import com.smartdevicelink.proxy.rpc.OnKeyboardInput; -import com.smartdevicelink.proxy.rpc.OnLanguageChange; -import com.smartdevicelink.proxy.rpc.OnLockScreenStatus; -import com.smartdevicelink.proxy.rpc.OnPermissionsChange; -import com.smartdevicelink.proxy.rpc.OnStreamRPC; -import com.smartdevicelink.proxy.rpc.OnSystemRequest; -import com.smartdevicelink.proxy.rpc.OnTBTClientState; -import com.smartdevicelink.proxy.rpc.OnTouchEvent; -import com.smartdevicelink.proxy.rpc.OnVehicleData; -import com.smartdevicelink.proxy.rpc.PerformAudioPassThruResponse; -import com.smartdevicelink.proxy.rpc.PerformInteractionResponse; -import com.smartdevicelink.proxy.rpc.PutFile; -import com.smartdevicelink.proxy.rpc.PutFileResponse; -import com.smartdevicelink.proxy.rpc.ReadDIDResponse; -import com.smartdevicelink.proxy.rpc.ResetGlobalPropertiesResponse; -import com.smartdevicelink.proxy.rpc.ScrollableMessageResponse; -import com.smartdevicelink.proxy.rpc.SendLocationResponse; -import com.smartdevicelink.proxy.rpc.SetAppIconResponse; -import com.smartdevicelink.proxy.rpc.SetDisplayLayoutResponse; -import com.smartdevicelink.proxy.rpc.SetGlobalPropertiesResponse; -import com.smartdevicelink.proxy.rpc.SetMediaClockTimerResponse; -import com.smartdevicelink.proxy.rpc.ShowConstantTbtResponse; -import com.smartdevicelink.proxy.rpc.ShowResponse; -import com.smartdevicelink.proxy.rpc.SliderResponse; -import com.smartdevicelink.proxy.rpc.SpeakResponse; -import com.smartdevicelink.proxy.rpc.StreamRPCResponse; -import com.smartdevicelink.proxy.rpc.SubscribeButtonResponse; -import com.smartdevicelink.proxy.rpc.SubscribeVehicleDataResponse; -import com.smartdevicelink.proxy.rpc.SystemRequestResponse; -import com.smartdevicelink.proxy.rpc.UnsubscribeButtonResponse; -import com.smartdevicelink.proxy.rpc.UnsubscribeVehicleDataResponse; -import com.smartdevicelink.proxy.rpc.UpdateTurnListResponse; -import com.smartdevicelink.proxy.rpc.enums.FileType; -import com.smartdevicelink.proxy.rpc.enums.SdlDisconnectedReason; -import com.smartdevicelink.proxy.rpc.enums.TextAlignment; -import com.smartdevicelink.transport.MultiplexTransportConfig; -import com.smartdevicelink.transport.TransportConstants; - -/** - * While this class is just an extension off the base Android Service class, we hope in the future we can offer something - * better that takes care of a lot of life cycle stuff. - * <p> - * For now this shows the most basic of operations to take when connecting via SDL - * Here's what it covers - * 1. Basic Sdl proxy life cycle - * 2. Sending app icon - * 3. When to launch activity and dealing with different HMI_STATUS's - * - * - * @author Joey Grover - * - */ -public class SdlService extends Service implements IProxyListenerALM{ - private static final String TAG = "SdlService"; - private static final String APP_NAME = "Hello Car"; //TODO enter your own app name here - private static final String APP_ID = "7331"; //TODO enter your own app id here - private static final String ICON_SYNC_FILENAME = "icon.png"; - private static final String ICON_FILENAME_SUFFIX = ".png"; - - - // variable to create and call functions of the SdlProxy - private SdlProxyALM proxy = null; - - // variable used to increment correlation ID for every request sent to a SDL system - public int autoIncCorrId = 0; - - @Override - public IBinder onBind(Intent intent) { - return null; - } - - - - @Override - public void onCreate() { - super.onCreate(); - startProxy(); - } - - - - @Override - public int onStartCommand(Intent intent, int flags, int startId) { - if(proxy == null){ - startProxy(); - }else if (intent != null && intent.hasExtra(TransportConstants.FORCE_TRANSPORT_CONNECTED)){ - proxy.forceOnConnected(); - } - return START_STICKY; - } - - @Override - public void onDestroy() { - disposeSyncProxy(); - super.onDestroy(); - } - - - /* *********************************************************************************************************************************************************************** - * ******************************************************* Methods for SdlProxy Management ******************************************************************************* - *************************************************************************************************************************************************************************/ - - public void startProxy() { - if (proxy == null) { - try { - proxy = new SdlProxyALM(this, APP_NAME, - true, APP_ID, - new MultiplexTransportConfig(getBaseContext(), APP_ID)); - - } catch (SdlException e) { - e.printStackTrace(); - // error creating proxy, returned proxy = null - if (proxy == null) { - stopSelf(); - } - } - } - } - - public void disposeSyncProxy() { - if (proxy != null) { - try { - proxy.dispose(); - } catch (SdlException e) { - e.printStackTrace(); - } - proxy = null; - } - } - - /** - * This will send the app icon over to the SDL system - * @throws SdlException - */ - private void sendIcon() throws SdlException { - PutFile putFile = new PutFile(); - putFile.setFileType(FileType.GRAPHIC_PNG); - putFile.setSdlFileName(ICON_SYNC_FILENAME); - putFile.setCorrelationID(autoIncCorrId++); - putFile.setBulkData(contentsOfResource(R.drawable.ic_launcher)); - - proxy.sendRPCRequest(putFile); - } - - /** - * This is a convience method that will grab all the binary data from a resource - * to be able to be sent to the SDL sytem - * @param resource - * @return - */ - private byte[] contentsOfResource(int resource) { - InputStream is = null; - try { - is = getResources().openRawResource(resource); - ByteArrayOutputStream os = new ByteArrayOutputStream(is.available()); - final int buffersize = 4096; - final byte[] buffer = new byte[buffersize]; - int available = 0; - while ((available = is.read(buffer)) >= 0) { - os.write(buffer, 0, available); - } - return os.toByteArray(); - } catch (IOException e) { - Log.w("SDL Service", "Can't read icon file", e); - return null; - } finally { - if (is != null) { - try { - is.close(); - } catch (IOException e) { - e.printStackTrace(); - } - } - } - } - - /* *********************************************************************************************************************************************************************** - * ******************************************************* Methods for IProxyListenerALM ******************************************************************************* - *************************************************************************************************************************************************************************/ - - @Override - public void onOnHMIStatus(OnHMIStatus notification) { - - switch(notification.getHmiLevel()) { - case HMI_FULL: - Log.i(TAG, "HMI_FULL"); - //When we get this notification it means we have main access to the SDL System - Intent start = new Intent(this,MainActivity.class); - start.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP + Intent.FLAG_ACTIVITY_NEW_TASK); - startActivity(start); - - if (notification.getFirstRun()) { - // send welcome message if applicable - try { - proxy.show(APP_NAME + " this is the first", "show command", TextAlignment.CENTERED, autoIncCorrId++); - }catch (SdlException e) { - e.printStackTrace(); - } - - // TODO this is where the developer should send addcommands and subsribe to buttons - }else { //If this isn't our first time receiving HMI_FULL - try { - proxy.show("SdlProxy is", "Alive", TextAlignment.CENTERED, autoIncCorrId++); - } catch (SdlException e) { - e.printStackTrace(); - } - } - break; - case HMI_LIMITED: - Log.i(TAG, "HMI_LIMITED"); - break; - case HMI_BACKGROUND: - Log.i(TAG, "HMI_BACKGROUND"); - break; - case HMI_NONE: - Log.i(TAG, "HMI_NONE"); - //Since the first HMI status sent to an app is HMI_NONE we take this as we have just established a connection and we want to send our icon - if(notification.getFirstRun()){ - try { - sendIcon(); - } catch (SdlException e) { - e.printStackTrace(); - } - } - break; - default: - return; - } - - } - - - @Override - public void onProxyClosed(String info, Exception e, SdlDisconnectedReason reason) { - //After we are asked to close the proxy we should shut down our service - stopSelf(); - } - - - @Override - public void onError(String info, Exception e) { - - - } - - - @Override - public void onGenericResponse(GenericResponse response) { - - - } - - - @Override - public void onOnCommand(OnCommand notification) { - - - } - - - @Override - public void onAddCommandResponse(AddCommandResponse response) { - - - } - - - @Override - public void onAddSubMenuResponse(AddSubMenuResponse response) { - - - } - - - @Override - public void onCreateInteractionChoiceSetResponse( - CreateInteractionChoiceSetResponse response) { - - - } - - - @Override - public void onAlertResponse(AlertResponse response) { - - - } - - - @Override - public void onDeleteCommandResponse(DeleteCommandResponse response) { - - - } - - - @Override - public void onDeleteInteractionChoiceSetResponse( - DeleteInteractionChoiceSetResponse response) { - - - } - - - @Override - public void onDeleteSubMenuResponse(DeleteSubMenuResponse response) { - - - } - - - @Override - public void onPerformInteractionResponse(PerformInteractionResponse response) { - - - } - - - @Override - public void onResetGlobalPropertiesResponse( - ResetGlobalPropertiesResponse response) { - - - } - - - @Override - public void onSetGlobalPropertiesResponse( - SetGlobalPropertiesResponse response) { - - - } - - - @Override - public void onSetMediaClockTimerResponse(SetMediaClockTimerResponse response) { - - - } - - - @Override - public void onShowResponse(ShowResponse response) { - - - } - - - @Override - public void onSpeakResponse(SpeakResponse response) { - - - } - - - @Override - public void onOnButtonEvent(OnButtonEvent notification) { - - - } - - - @Override - public void onOnButtonPress(OnButtonPress notification) { - - - } - - - @Override - public void onSubscribeButtonResponse(SubscribeButtonResponse response) { - - - } - - - @Override - public void onUnsubscribeButtonResponse(UnsubscribeButtonResponse response) { - - - } - - - @Override - public void onOnPermissionsChange(OnPermissionsChange notification) { - - - } - - - @Override - public void onSubscribeVehicleDataResponse( - SubscribeVehicleDataResponse response) { - - - } - - - @Override - public void onUnsubscribeVehicleDataResponse( - UnsubscribeVehicleDataResponse response) { - - - } - - - @Override - public void onGetVehicleDataResponse(GetVehicleDataResponse response) { - - - } - - - @Override - public void onOnVehicleData(OnVehicleData notification) { - - - } - - - @Override - public void onPerformAudioPassThruResponse( - PerformAudioPassThruResponse response) { - - - } - - - @Override - public void onEndAudioPassThruResponse(EndAudioPassThruResponse response) { - - - } - - - @Override - public void onOnAudioPassThru(OnAudioPassThru notification) { - - - } - - - @Override - public void onPutFileResponse(PutFileResponse response) { - - - } - - - @Override - public void onDeleteFileResponse(DeleteFileResponse response) { - - - } - - - @Override - public void onListFilesResponse(ListFilesResponse response) { - - - } - - - @Override - public void onSetAppIconResponse(SetAppIconResponse response) { - - - } - - - @Override - public void onScrollableMessageResponse(ScrollableMessageResponse response) { - - - } - - - @Override - public void onChangeRegistrationResponse(ChangeRegistrationResponse response) { - - - } - - - @Override - public void onSetDisplayLayoutResponse(SetDisplayLayoutResponse response) { - - - } - - - @Override - public void onOnLanguageChange(OnLanguageChange notification) { - - - } - - - @Override - public void onOnHashChange(OnHashChange notification) { - - - } - - - @Override - public void onSliderResponse(SliderResponse response) { - - - } - - - @Override - public void onOnDriverDistraction(OnDriverDistraction notification) { - - - } - - - @Override - public void onOnTBTClientState(OnTBTClientState notification) { - - - } - - - @Override - public void onOnSystemRequest(OnSystemRequest notification) { - - - } - - - @Override - public void onSystemRequestResponse(SystemRequestResponse response) { - - } - - - @Override - public void onOnKeyboardInput(OnKeyboardInput notification) { - - } - - - @Override - public void onOnTouchEvent(OnTouchEvent notification) { - - } - - - @Override - public void onDiagnosticMessageResponse(DiagnosticMessageResponse response) { - - } - - - @Override - public void onReadDIDResponse(ReadDIDResponse response) { - - } - - - @Override - public void onGetDTCsResponse(GetDTCsResponse response) { - - } - - - @Override - public void onOnLockScreenNotification(OnLockScreenStatus notification) { - - } - - - @Override - public void onOnStreamRPC(OnStreamRPC notification) { - // TODO Auto-generated method stub - - } - - - @Override - public void onStreamRPCResponse(StreamRPCResponse response) { - // TODO Auto-generated method stub - - } - - - @Override - public void onDialNumberResponse(DialNumberResponse response) { - // TODO Auto-generated method stub - - } - - - @Override - public void onSendLocationResponse(SendLocationResponse response) { - // TODO Auto-generated method stub - - } - - - @Override - public void onServiceEnded(OnServiceEnded serviceEnded) { - // TODO Auto-generated method stub - - } - - - @Override - public void onServiceNACKed(OnServiceNACKed serviceNACKed) { - // TODO Auto-generated method stub - - } - - - @Override - public void onShowConstantTbtResponse(ShowConstantTbtResponse response) { - // TODO Auto-generated method stub - - } - - - @Override - public void onAlertManeuverResponse(AlertManeuverResponse response) { - // TODO Auto-generated method stub - - } - - - @Override - public void onUpdateTurnListResponse(UpdateTurnListResponse response) { - // TODO Auto-generated method stub - - } - - - @Override - public void onServiceDataACK() { - // TODO Auto-generated method stub - - } - -} diff --git a/sdl_android_lib/src/com/smartdevicelink/SdlConnection/SdlConnection.java b/sdl_android_lib/src/com/smartdevicelink/SdlConnection/SdlConnection.java index 60d6e5362..3a4e74c3a 100644 --- a/sdl_android_lib/src/com/smartdevicelink/SdlConnection/SdlConnection.java +++ b/sdl_android_lib/src/com/smartdevicelink/SdlConnection/SdlConnection.java @@ -556,7 +556,6 @@ public class SdlConnection implements IProtocolListener, ITransportListener, ISt } catch (SdlException e) {
e.printStackTrace();
}
- ((MultiplexTransport)_transport).forceHardwareConnectEvent(TransportType.BLUETOOTH);
}
}else{ //The service must be null or already consumed. Let's see if we can find the connection that consumed it
for (SdlSession session : listenerList) {
@@ -734,12 +733,14 @@ public class SdlConnection implements IProtocolListener, ITransportListener, ISt ComponentName tempCompName = SdlBroadcastReceiver.consumeQueuedRouterService();
//Log.d(TAG, "Consumed component name: " +tempCompName );
if(config.getService().equals(tempCompName)){ //If this is the same service that just connected that we are already looking at. Attempt to reconnect
- boolean forced = multi.forceHardwareConnectEvent(TransportType.BLUETOOTH);
-
- if(!forced && multi.isDisconnecting() ){ //If we aren't able to force a connection it means the
+ if(!multi.getIsConnected() && multi.isDisconnecting() ){ //If we aren't able to force a connection it means the
//Log.d(TAG, "Recreating our multiplexing transport");
_transport = new MultiplexTransport(config,this);
- ((MultiplexTransport)_transport).forceHardwareConnectEvent(TransportType.BLUETOOTH);
+ try {
+ startTransport();
+ } catch (SdlException e) {
+ e.printStackTrace();
+ }
}//else{Log.w(TAG, "Guess we're just calling it a day");}
}else if(tempCompName!=null){
//We have a conflicting service request
@@ -754,7 +755,6 @@ public class SdlConnection implements IProtocolListener, ITransportListener, ISt } catch (SdlException e) {
e.printStackTrace();
}
- ((MultiplexTransport)_transport).forceHardwareConnectEvent(TransportType.BLUETOOTH);
}
}else if(_transport.getTransportType()==TransportType.BLUETOOTH
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/RPCResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/RPCResponse.java index 4527602a3..0a4dc2a70 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/RPCResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/RPCResponse.java @@ -22,18 +22,18 @@ import com.smartdevicelink.proxy.rpc.enums.Result; * </li> <li>ResultCode:
* <ul>
*
- * The result code provides additional information about a response returning a
- * failed outcome.
- * <br>
+ * <p>The result code provides additional information about a response returning a
+ * failed outcome.</p>
*
- * Any response can have at least one, or possibly more, of the following result
+ *
+ * <p>Any response can have at least one, or possibly more, of the following result
* code values: SUCCESS, INVALID_DATA, OUT_OF_MEMORY, TOO_MANY_PENDING_REQUESTS,
- * APPLICATION_NOT_REGISTERED, GENERIC_ERROR,REJECTED.
- * <br>
+ * APPLICATION_NOT_REGISTERED, GENERIC_ERROR,REJECTED.</p>
+ *
+ *
+ * <p>Any additional result codes for a given operation can be found in related
+ * RPCs</p>
*
- * Any additional result codes for a given operation can be found in related
- * RPCs
- * <br>
* </ul>
* </li> <li>Info:
* <ul>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/SdlProxyALM.java b/sdl_android_lib/src/com/smartdevicelink/proxy/SdlProxyALM.java index 8b9174a19..2bdbdf82e 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/SdlProxyALM.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/SdlProxyALM.java @@ -37,11 +37,41 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { private static final String SDL_LIB_TRACE_KEY = "42baba60-eb57-11df-98cf-0800200c9a66";
@SuppressWarnings("unused")
private static final String SDL_LIB_PRIVATE_TOKEN = "{DAE1A88C-6C16-4768-ACA5-6F1247EA01C2}";
+ /**
+ * @deprecated
+ * Constructor for the SdlProxy object, the proxy for communicating between the App and SDL
+ *
+ * Takes advantage of the advanced lifecycle management.
+ * @param listener - Reference to the object in the App listening to callbacks from SDL.
+ * @param appName - Name of the application displayed on SDL.
+ * @param isMediaApp - Indicates if the app is a media application.
+ */
+ @Deprecated
+ public SdlProxyALM(IProxyListenerALM listener, String appName, Boolean isMediaApp,
+ Language languageDesired, Language hmiDisplayLanguageDesired, String appID) throws SdlException {
+ super( listener,
+ /*sdl proxy configuration resources*/null,
+ /*enable advanced lifecycle management*/true,
+ appName,
+ /*TTS Name*/null,
+ /*ngn media app*/null,
+ /*vr synonyms*/null,
+ /*is media app*/isMediaApp,
+ /*sdlMsgVersion*/null,
+ /*language desired*/languageDesired,
+ /*HMI Display Language Desired*/hmiDisplayLanguageDesired,
+ /*App Type*/null,
+ /*App ID*/appID,
+ /*autoActivateID*/null,
+ /*callbackToUIThread*/ false,
+ new BTTransportConfig());
+ }
/**
* Constructor for the SdlProxy object, the proxy for communicating between the App and SDL
*
* Takes advantage of the advanced lifecycle management.
+ * @param context - Used to create a multiplexing transport config
* @param listener - Reference to the object in the App listening to callbacks from SDL.
* @param appName - Name of the application displayed on SDL.
* @param isMediaApp - Indicates if the app is a media application.
@@ -67,12 +97,55 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { SdlTrace.logProxyEvent("Application constructed SdlProxyALM (using legacy constructor for BT transport) instance passing in: IProxyListener, appName, and isMediaApp.", SDL_LIB_TRACE_KEY);
}
-
+ /**
+ * @deprecated
+ * Constructor for the SdlProxy object, the proxy for communicating between the App and SDL.
+ *
+ * Takes advantage of the advanced lifecycle management.
+ *
+ * @param listener - Reference to the object in the App listening to callbacks from SDL.
+ * @param appName - Name of the application displayed on SDL.
+ * @param ngnMediaScreenAppName - Name of the application displayed on SDL for Navigation equipped
+ * vehicles. Limited to five characters.
+ * @param vrSynonyms - A vector of strings, all of which can be used as voice commands to
+ * @param isMediaApp - Indicates if the app is a media application.
+ * @param sdlMsgVersion - Indicates the version of SDL SmartDeviceLink Messages desired. Must be less than
+ * or equal to the version of SDL SmartDeviceLink running on the vehicle.
+ * @param languageDesired - Indicates the language desired for the SDL interface.
+ * @param autoActivateID - ID used to re-register previously registered application.
+ * @throws SdlException
+ */
+ @Deprecated
+ public SdlProxyALM(IProxyListenerALM listener, String appName, String ngnMediaScreenAppName,
+ Vector<String> vrSynonyms, Boolean isMediaApp, SdlMsgVersion sdlMsgVersion,
+ Language languageDesired, Language hmiDisplayLanguageDesired, String appID,
+ String autoActivateID) throws SdlException {
+ super( listener,
+ /*sdl proxy configuration resources*/null,
+ /*enable advanced lifecycle management*/true,
+ appName,
+ /*TTS Name*/null,
+ ngnMediaScreenAppName,
+ vrSynonyms,
+ isMediaApp,
+ sdlMsgVersion,
+ languageDesired,
+ /*HMI Display Language Desired*/hmiDisplayLanguageDesired,
+ /*App Type*/null,
+ /*App ID*/appID,
+ autoActivateID,
+ /*callbackToUIThread*/ false,
+ new BTTransportConfig());
+
+ SdlTrace.logProxyEvent("Application constructed SdlProxyALM (using legacy constructor for BT transport) instance passing in: IProxyListener, appName, ngnMediaScreenAppName, " +
+ "vrSynonyms, isMediaApp, sdlMsgVersion, languageDesired, and autoActivateID.", SDL_LIB_TRACE_KEY);
+ }
/**
* Constructor for the SdlProxy object, the proxy for communicating between the App and SDL.
*
* Takes advantage of the advanced lifecycle management.
*
+ * @param context - Used to create a multiplexing transport config
* @param listener - Reference to the object in the App listening to callbacks from SDL.
* @param appName - Name of the application displayed on SDL.
* @param ngnMediaScreenAppName - Name of the application displayed on SDL for Navigation equipped
@@ -109,8 +182,8 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { SdlTrace.logProxyEvent("Application constructed SdlProxyALM (using legacy constructor for BT transport) instance passing in: IProxyListener, appName, ngnMediaScreenAppName, " +
"vrSynonyms, isMediaApp, sdlMsgVersion, languageDesired, and autoActivateID.", SDL_LIB_TRACE_KEY);
}
-
/**
+ * @deprecated
* Constructor for the SdlProxy object, the proxy for communicating between the App and SDL.
*
* Takes advantage of the advanced lifecycle management.
@@ -127,6 +200,49 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { * @param autoActivateID - ID used to re-register previously registered application.
* @throws SdlException
*/
+ @Deprecated
+ public SdlProxyALM(IProxyListenerALM listener, SdlProxyConfigurationResources sdlProxyConfigurationResources,
+ String appName, String ngnMediaScreenAppName, Vector<String> vrSynonyms,
+ Boolean isMediaApp, SdlMsgVersion sdlMsgVersion, Language languageDesired,
+ Language hmiDisplayLanguageDesired, String appID, String autoActivateID) throws SdlException {
+ super( listener,
+ sdlProxyConfigurationResources,
+ /*enable advanced lifecycle management*/true,
+ appName,
+ /*TTS Name*/null,
+ ngnMediaScreenAppName,
+ vrSynonyms,
+ isMediaApp,
+ sdlMsgVersion,
+ languageDesired,
+ /*HMI Display Language Desired*/hmiDisplayLanguageDesired,
+ /*App Type*/null,
+ /*App ID*/appID,
+ autoActivateID,
+ /*callbackToUIThread*/ false,
+ new BTTransportConfig());
+
+ SdlTrace.logProxyEvent("Application constructed SdlProxyALM (using legacy constructor for BT transport) instance passing in: IProxyListener, sdlProxyConfigurationResources, " +
+ "appName, ngnMediaScreenAppName, vrSynonyms, isMediaApp, sdlMsgVersion, languageDesired, and autoActivateID.", SDL_LIB_TRACE_KEY);
+ }
+ /**
+ * Constructor for the SdlProxy object, the proxy for communicating between the App and SDL.
+ *
+ * Takes advantage of the advanced lifecycle management.
+ *
+ * @param context - Used to create a multiplexing transport config
+ * @param listener - Reference to the object in the App listening to callbacks from SDL.
+ * @param appName - Name of the application displayed on SDL.
+ * @param ngnMediaScreenAppName - Name of the application displayed on SDL for Navigation equipped
+ * vehicles. Limited to five characters.
+ * @param vrSynonyms - A vector of strings, all of which can be used as voice commands to
+ * @param isMediaApp - Indicates if the app is a media application.
+ * @param sdlMsgVersion - Indicates the version of SDL SmartDeviceLink Messages desired. Must be less than
+ * or equal to the version of SDL SmartDeviceLink running on the vehicle.
+ * @param languageDesired - Indicates the language desired for the SDL interface.
+ * @param autoActivateID - ID used to re-register previously registered application.
+ * @throws SdlException
+ */
public SdlProxyALM(Context context,IProxyListenerALM listener, SdlProxyConfigurationResources sdlProxyConfigurationResources,
String appName, String ngnMediaScreenAppName, Vector<String> vrSynonyms,
Boolean isMediaApp, SdlMsgVersion sdlMsgVersion, Language languageDesired,
@@ -151,8 +267,8 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { SdlTrace.logProxyEvent("Application constructed SdlProxyALM (using legacy constructor for BT transport) instance passing in: IProxyListener, sdlProxyConfigurationResources, " +
"appName, ngnMediaScreenAppName, vrSynonyms, isMediaApp, sdlMsgVersion, languageDesired, and autoActivateID.", SDL_LIB_TRACE_KEY);
}
-
/**
+ * @deprecated
* Constructor for the SdlProxy object, the proxy for communicating between the App and SDL.
*
* Takes advantage of the advanced lifecycle management.
@@ -170,6 +286,51 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { * @param callbackToUIThread - If true, all callbacks will occur on the UI thread.
* @throws SdlException
*/
+ @Deprecated
+ public SdlProxyALM(IProxyListenerALM listener, String appName, String ngnMediaScreenAppName,
+ Vector<String> vrSynonyms, Boolean isMediaApp, SdlMsgVersion sdlMsgVersion,
+ Language languageDesired, Language hmiDisplayLanguageDesired, String appID,
+ String autoActivateID, boolean callbackToUIThread) throws SdlException {
+ super( listener,
+ /*sdl proxy configuration resources*/null,
+ /*enable advanced lifecycle management*/true,
+ appName,
+ /*TTS Name*/null,
+ ngnMediaScreenAppName,
+ vrSynonyms,
+ isMediaApp,
+ sdlMsgVersion,
+ languageDesired,
+ /*HMI Display Language Desired*/hmiDisplayLanguageDesired,
+ /*App Type*/null,
+ /*App ID*/appID,
+ autoActivateID,
+ callbackToUIThread,
+ new BTTransportConfig());
+
+ SdlTrace.logProxyEvent("Application constructed SdlProxyALM (using legacy constructor for BT transport) instance passing in: IProxyListener, " +
+ "appName, ngnMediaScreenAppName, vrSynonyms, isMediaApp, sdlMsgVersion, languageDesired, autoActivateID, " +
+ "and callbackToUIThread", SDL_LIB_TRACE_KEY);
+ }
+ /**
+ * Constructor for the SdlProxy object, the proxy for communicating between the App and SDL.
+ *
+ * Takes advantage of the advanced lifecycle management.
+ *
+ * @param context - Used to create a multiplexing transport config
+ * @param listener - Reference to the object in the App listening to callbacks from SDL.
+ * @param appName - Name of the application displayed on SDL.
+ * @param ngnMediaScreenAppName - Name of the application displayed on SDL for Navigation equipped
+ * vehicles. Limited to five characters.
+ * @param vrSynonyms - A vector of strings, all of which can be used as voice commands to
+ * @param isMediaApp - Indicates if the app is a media application.
+ * @param sdlMsgVersion - Indicates the version of SDL SmartDeviceLink Messages desired. Must be less than
+ * or equal to the version of SDL SmartDeviceLink running on the vehicle.
+ * @param languageDesired - Indicates the language desired for the SDL interface.
+ * @param autoActivateID - ID used to re-register previously registered application.
+ * @param callbackToUIThread - If true, all callbacks will occur on the UI thread.
+ * @throws SdlException
+ */
public SdlProxyALM(Context context,IProxyListenerALM listener, String appName, String ngnMediaScreenAppName,
Vector<String> vrSynonyms, Boolean isMediaApp, SdlMsgVersion sdlMsgVersion,
Language languageDesired, Language hmiDisplayLanguageDesired, String appID,
@@ -195,8 +356,8 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { "appName, ngnMediaScreenAppName, vrSynonyms, isMediaApp, sdlMsgVersion, languageDesired, autoActivateID, " +
"and callbackToUIThread", SDL_LIB_TRACE_KEY);
}
-
/**
+ * @deprecated
* Constructor for the SdlProxy object, the proxy for communicating between the App and SDL.
*
* Takes advantage of the advanced lifecycle management.
@@ -214,6 +375,52 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { * @param callbackToUIThread - If true, all callbacks will occur on the UI thread.
* @throws SdlException
*/
+ @Deprecated
+ public SdlProxyALM(IProxyListenerALM listener, SdlProxyConfigurationResources sdlProxyConfigurationResources,
+ String appName, String ngnMediaScreenAppName, Vector<String> vrSynonyms, Boolean isMediaApp,
+ SdlMsgVersion sdlMsgVersion, Language languageDesired, Language hmiDisplayLanguageDesired,
+ String appID, String autoActivateID,
+ boolean callbackToUIThread) throws SdlException {
+ super( listener,
+ sdlProxyConfigurationResources,
+ /*enable advanced lifecycle management*/true,
+ appName,
+ /*TTS Name*/null,
+ ngnMediaScreenAppName,
+ vrSynonyms,
+ isMediaApp,
+ sdlMsgVersion,
+ languageDesired,
+ /*HMI Display Language Desired*/hmiDisplayLanguageDesired,
+ /*App Type*/null,
+ /*App ID*/appID,
+ autoActivateID,
+ callbackToUIThread,
+ new BTTransportConfig());
+
+ SdlTrace.logProxyEvent("Application constructed SdlProxyALM (using legacy constructor for BT transport) instance passing in: IProxyListener, sdlProxyConfigurationResources, " +
+ "appName, ngnMediaScreenAppName, vrSynonyms, isMediaApp, sdlMsgVersion, languageDesired, autoActivateID, " +
+ "and callbackToUIThread", SDL_LIB_TRACE_KEY);
+ }
+ /**
+ * Constructor for the SdlProxy object, the proxy for communicating between the App and SDL.
+ *
+ * Takes advantage of the advanced lifecycle management.
+ *
+ * @param context - Used to create a multiplexing transport config
+ * @param listener - Reference to the object in the App listening to callbacks from SDL.
+ * @param appName - Name of the application displayed on SDL.
+ * @param ngnMediaScreenAppName - Name of the application displayed on SDL for Navigation equipped
+ * vehicles. Limited to five characters.
+ * @param vrSynonyms - A vector of strings, all of which can be used as voice commands to
+ * @param isMediaApp - Indicates if the app is a media application.
+ * @param sdlMsgVersion - Indicates the version of SDL SmartDeviceLink Messages desired. Must be less than
+ * or equal to the version of SDL SmartDeviceLink running on the vehicle.
+ * @param languageDesired - Indicates the language desired for the SDL interface.
+ * @param autoActivateID - ID used to re-register previously registered application.
+ * @param callbackToUIThread - If true, all callbacks will occur on the UI thread.
+ * @throws SdlException
+ */
public SdlProxyALM(Context context,IProxyListenerALM listener, SdlProxyConfigurationResources sdlProxyConfigurationResources,
String appName, String ngnMediaScreenAppName, Vector<String> vrSynonyms, Boolean isMediaApp,
SdlMsgVersion sdlMsgVersion, Language languageDesired, Language hmiDisplayLanguageDesired,
@@ -241,6 +448,34 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { "and callbackToUIThread", SDL_LIB_TRACE_KEY);
}
+ @Deprecated
+ public SdlProxyALM(IProxyListenerALM listener, SdlProxyConfigurationResources sdlProxyConfigurationResources,
+ String appName, String ngnMediaScreenAppName, Vector<String> vrSynonyms, Boolean isMediaApp,
+ SdlMsgVersion sdlMsgVersion, Language languageDesired, Language hmiDisplayLanguageDesired,
+ String appID, String autoActivateID, boolean callbackToUIThread, boolean preRegister) throws SdlException {
+ super( listener,
+ sdlProxyConfigurationResources,
+ /*enable advanced lifecycle management*/true,
+ appName,
+ /*TTS Name*/null,
+ ngnMediaScreenAppName,
+ vrSynonyms,
+ isMediaApp,
+ sdlMsgVersion,
+ languageDesired,
+ /*HMI Display Language Desired*/hmiDisplayLanguageDesired,
+ /*App Type*/null,
+ /*App ID*/appID,
+ autoActivateID,
+ callbackToUIThread,
+ preRegister,
+ new BTTransportConfig());
+
+ SdlTrace.logProxyEvent("Application constructed SdlProxyALM (using legacy constructor for BT transport) instance passing in: IProxyListener, sdlProxyConfigurationResources, " +
+ "appName, ngnMediaScreenAppName, vrSynonyms, isMediaApp, sdlMsgVersion, languageDesired, autoActivateID, " +
+ "callbackToUIThread and version", SDL_LIB_TRACE_KEY);
+ }
+
public SdlProxyALM(Context context,IProxyListenerALM listener, SdlProxyConfigurationResources sdlProxyConfigurationResources,
String appName, String ngnMediaScreenAppName, Vector<String> vrSynonyms, Boolean isMediaApp,
SdlMsgVersion sdlMsgVersion, Language languageDesired, Language hmiDisplayLanguageDesired,
@@ -535,10 +770,52 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { }
/**
+ * @deprecated
+ * Constructor for the SdlProxy object, the proxy for communicating between the App and SDL via specified transport.
+ *
+ * Takes advantage of the advanced lifecycle management.
+ *
+ * @param listener Reference to the object in the App listening to callbacks from SDL.
+ * @param appName Name of the application displayed on SDL.
+ * @param isMediaApp Indicates if the app is a media application.
+ * @param languageDesired Indicates the language desired for the SDL interface.
+ * @param hmiDisplayLanguageDesired Desired language in HMI.
+ * @param appID Identifier of the client application.
+ * @param callbackToUIThread If true, all callbacks will occur on the UI thread.
+ * @param preRegister Flag that indicates that client should be pre-registred or not
+ * @throws SdlException
+ */
+ @Deprecated
+ public SdlProxyALM(IProxyListenerALM listener, String appName, Boolean isMediaApp,Language languageDesired, Language hmiDisplayLanguageDesired,
+ String appID, boolean callbackToUIThread, boolean preRegister) throws SdlException
+ {
+ super( listener,
+ /*sdlProxyConfigurationResources*/null,
+ /*enable advanced lifecycle management*/true,
+ appName,
+ /*ttsName*/null,
+ /*ngnMediaScreenAppName*/null,
+ /*vrSynonyms*/null,
+ isMediaApp,
+ /*sdlMsgVersion*/null,
+ languageDesired,
+ hmiDisplayLanguageDesired,
+ /*App Type*/null,
+ /*App ID*/appID,
+ /*autoActivateID*/null,
+ callbackToUIThread,
+ preRegister,
+ new BTTransportConfig());
+
+ SdlTrace.logProxyEvent("Application constructed SdlProxyALM (using legacy constructor for BT transport) instance passing in: IProxyListener, " +
+ "appName, isMediaApp, languageDesired, hmiDisplayLanguageDesired" + "callbackToUIThread and version", SDL_LIB_TRACE_KEY);
+ }
+ /**
* Constructor for the SdlProxy object, the proxy for communicating between the App and SDL via specified transport.
*
* Takes advantage of the advanced lifecycle management.
*
+ * @param context - Used to create a multiplexing transport config
* @param listener Reference to the object in the App listening to callbacks from SDL.
* @param appName Name of the application displayed on SDL.
* @param isMediaApp Indicates if the app is a media application.
@@ -575,10 +852,47 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { }
/**
+ * @deprecated
+ * Constructor for the SdlProxy object, the proxy for communicating between the App and SDL via specified transport.
+ *
+ * Takes advantage of the advanced lifecycle management.
+ *
+ * @param listener Reference to the object in the App listening to callbacks from SDL.
+ * @param appName Name of the application displayed on SDL.
+ * @param isMediaApp Indicates if the app is a media application.
+ * @param appID Identifier of the client application.
+ * @throws SdlException
+ */
+ @Deprecated
+ public SdlProxyALM(IProxyListenerALM listener, String appName, Boolean isMediaApp,String appID) throws SdlException {
+ super( listener,
+ /*sdlProxyConfigurationResources*/null,
+ /*enable advanced lifecycle management*/true,
+ appName,
+ /*ttsName*/null,
+ /*ngnMediaScreenAppName*/null,
+ /*vrSynonyms*/null,
+ isMediaApp,
+ /*sdlMsgVersion*/null,
+ /*languageDesired*/null,
+ /*hmiDisplayLanguageDesired*/null,
+ /*App Type*/null,
+ /*App ID*/appID,
+ /*autoActivateID*/null,
+ false,
+ false,
+ new BTTransportConfig());
+
+ SdlTrace.logProxyEvent("Application constructed SdlProxyALM (using legacy constructor for BT transport) instance passing in: IProxyListener, " +
+ "appName, isMediaApp, appID", SDL_LIB_TRACE_KEY);
+ }
+
+ /**
* Constructor for the SdlProxy object, the proxy for communicating between the App and SDL via specified transport.
*
* Takes advantage of the advanced lifecycle management.
*
+ * @param context - Used to create a multiplexing transport config
* @param listener Reference to the object in the App listening to callbacks from SDL.
* @param appName Name of the application displayed on SDL.
* @param isMediaApp Indicates if the app is a media application.
@@ -609,6 +923,7 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { }
/**
+ * @deprecated
* Constructor for the SdlProxy object, the proxy for communicating between the App and SDL via specified transport.
*
* Takes advantage of the advanced lifecycle management.
@@ -619,7 +934,8 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { * @param isMediaApp Indicates if the app is a media application.
* @param appID Identifier of the client application.
* @throws SdlException
- */
+ */
+ @Deprecated
public SdlProxyALM(IProxyListenerALM listener, SdlProxyConfigurationResources sdlProxyConfigurationResources, String appName, Boolean isMediaApp,String appID) throws SdlException {
super( listener,
sdlProxyConfigurationResources,
@@ -643,6 +959,42 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { "sdlProxyConfigurationResources, appName, isMediaApp, appID", SDL_LIB_TRACE_KEY);
}
+ /**
+ * Constructor for the SdlProxy object, the proxy for communicating between the App and SDL via specified transport.
+ *
+ * Takes advantage of the advanced lifecycle management.
+ *
+ * @param context - Used to create a multiplexing transport config
+ * @param listener Reference to the object in the App listening to callbacks from SDL.
+ * @param sdlProxyConfigurationResources Proxy configuration resources.
+ * @param appName Name of the application displayed on SDL.
+ * @param isMediaApp Indicates if the app is a media application.
+ * @param appID Identifier of the client application.
+ * @throws SdlException
+ */
+ public SdlProxyALM(Context context, IProxyListenerALM listener, SdlProxyConfigurationResources sdlProxyConfigurationResources, String appName, Boolean isMediaApp,String appID) throws SdlException {
+ super( listener,
+ sdlProxyConfigurationResources,
+ /*enable advanced lifecycle management*/true,
+ appName,
+ /*ttsName*/null,
+ /*ngnMediaScreenAppName*/null,
+ /*vrSynonyms*/null,
+ isMediaApp,
+ /*sdlMsgVersion*/null,
+ /*languageDesired*/null,
+ /*hmiDisplayLanguageDesired*/null,
+ /*App Type*/null,
+ /*App ID*/appID,
+ /*autoActivateID*/null,
+ false,
+ false,
+ new MultiplexTransportConfig(context,appID));
+
+ SdlTrace.logProxyEvent("Application constructed SdlProxyALM (using legacy constructor for BT transport) instance passing in: IProxyListener, " +
+ "sdlProxyConfigurationResources, appName, isMediaApp, appID", SDL_LIB_TRACE_KEY);
+ }
+
public SdlProxyALM(IProxyListenerALM listener, String appName, Boolean isMediaApp,String appID,BaseTransportConfig transportConfig) throws SdlException {
super( listener,
/*sdlProxyConfigurationResources*/null,
@@ -666,8 +1018,8 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { "appName, isMediaApp, appID", SDL_LIB_TRACE_KEY);
}
-
/**
+ * @deprecated
* Constructor for the SdlProxy object, the proxy for communicating between the App and SDL via specified transport.
*
* Takes advantage of the advanced lifecycle management.
@@ -680,6 +1032,44 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { * @param preRegister Flag that indicates that client should be pre-registred or not
* @throws SdlException
*/
+ @Deprecated
+ public SdlProxyALM(IProxyListenerALM listener, String appName, Boolean isMediaApp,String appID,
+ boolean callbackToUIThread, boolean preRegister) throws SdlException {
+ super( listener,
+ /*sdlProxyConfigurationResources*/null,
+ /*enable advanced lifecycle management*/true,
+ appName,
+ /*ttsName*/null,
+ /*ngnMediaScreenAppName*/null,
+ /*vrSynonyms*/null,
+ isMediaApp,
+ /*sdlMsgVersion*/null,
+ /*languageDesired*/null,
+ /*hmiDisplayLanguageDesired*/null,
+ /*App Type*/null,
+ /*App ID*/appID,
+ /*autoActivateID*/null,
+ callbackToUIThread,
+ preRegister,
+ new BTTransportConfig());
+
+ SdlTrace.logProxyEvent("Application constructed SdlProxyALM (using legacy constructor for BT transport) instance passing in: IProxyListener, " +
+ "appName, isMediaApp, " + "callbackToUIThread and version", SDL_LIB_TRACE_KEY);
+ }
+ /**
+ * Constructor for the SdlProxy object, the proxy for communicating between the App and SDL via specified transport.
+ *
+ * Takes advantage of the advanced lifecycle management.
+ *
+ * @param context - Used to create a multiplexing transport config
+ * @param listener Reference to the object in the App listening to callbacks from SDL.
+ * @param appName Name of the application displayed on SDL.
+ * @param isMediaApp Indicates if the app is a media application.
+ * @param appID Identifier of the client application.
+ * @param callbackToUIThread If true, all callbacks will occur on the UI thread.
+ * @param preRegister Flag that indicates that client should be pre-registred or not
+ * @throws SdlException
+ */
public SdlProxyALM(Context context,IProxyListenerALM listener, String appName, Boolean isMediaApp,String appID,
boolean callbackToUIThread, boolean preRegister) throws SdlException {
super( listener,
@@ -790,8 +1180,8 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { -
/**
+ * @deprecated
* Constructor for the SdlProxy object, the proxy for communicating between the App and SDL via specified transport.
*
* Takes advantage of the advanced lifecycle management.
@@ -814,6 +1204,57 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { * @param preRegister Flag that indicates that client should be pre-registred or not
* @throws SdlException
*/
+ @Deprecated
+ public SdlProxyALM(IProxyListenerALM listener, SdlProxyConfigurationResources sdlProxyConfigurationResources,
+ String appName, Vector<TTSChunk> ttsName, String ngnMediaScreenAppName, Vector<String> vrSynonyms, Boolean isMediaApp,
+ SdlMsgVersion sdlMsgVersion, Language languageDesired, Language hmiDisplayLanguageDesired,
+ String appID, String autoActivateID, boolean callbackToUIThread, boolean preRegister) throws SdlException {
+ super( listener,
+ sdlProxyConfigurationResources,
+ /*enable advanced lifecycle management*/true,
+ appName,
+ ttsName,
+ ngnMediaScreenAppName,
+ vrSynonyms,
+ isMediaApp,
+ sdlMsgVersion,
+ languageDesired,
+ /*HMI Display Language Desired*/hmiDisplayLanguageDesired,
+ /*App Type*/null,
+ /*App ID*/appID,
+ autoActivateID,
+ callbackToUIThread,
+ preRegister,
+ new BTTransportConfig());
+
+ SdlTrace.logProxyEvent("Application constructed SdlProxyALM (using legacy constructor for BT transport) instance passing in: IProxyListener, sdlProxyConfigurationResources, " +
+ "appName, ngnMediaScreenAppName, vrSynonyms, isMediaApp, sdlMsgVersion, languageDesired, autoActivateID, " +
+ "callbackToUIThread and version", SDL_LIB_TRACE_KEY);
+ }
+ /**
+ * Constructor for the SdlProxy object, the proxy for communicating between the App and SDL via specified transport.
+ *
+ * Takes advantage of the advanced lifecycle management.
+ *
+ * @param context - Used to create a multiplexing transport config
+ * @param listener Reference to the object in the App listening to callbacks from SDL.
+ * @param sdlProxyConfigurationResources Proxy configuration resources.
+ * @param appName Name of the application displayed on SDL.
+ * @param ttsName TTS name.
+ * @param ngnMediaScreenAppName Name of the application displayed on SDL for Navigation equipped
+ * vehicles. Limited to five characters.
+ * @param vrSynonyms A vector of strings, all of which can be used as voice commands too
+ * @param isMediaApp Indicates if the app is a media application.
+ * @param sdlMsgVersion Indicates the version of SDL SmartDeviceLink Messages desired. Must be less than
+ * or equal to the version of SDL SmartDeviceLink running on the vehicle.
+ * @param languageDesired Indicates the language desired for the SDL interface.
+ * @param hmiDisplayLanguageDesired Desired language in HMI.
+ * @param appID Identifier of the client application.
+ * @param autoActivateID ID used to re-register previously registered application.
+ * @param callbackToUIThread If true, all callbacks will occur on the UI thread.
+ * @param preRegister Flag that indicates that client should be pre-registred or not
+ * @throws SdlException
+ */
public SdlProxyALM(Context context,IProxyListenerALM listener, SdlProxyConfigurationResources sdlProxyConfigurationResources,
String appName, Vector<TTSChunk> ttsName, String ngnMediaScreenAppName, Vector<String> vrSynonyms, Boolean isMediaApp,
SdlMsgVersion sdlMsgVersion, Language languageDesired, Language hmiDisplayLanguageDesired,
@@ -893,12 +1334,64 @@ public class SdlProxyALM extends SdlProxyBase<IProxyListenerALM> { "appName, ngnMediaScreenAppName, vrSynonyms, isMediaApp, sdlMsgVersion, languageDesired, autoActivateID, " +
"callbackToUIThread and version", SDL_LIB_TRACE_KEY);
}
-
+ /**
+ * @deprecated
+ * Constructor for the SdlProxy object, the proxy for communicating between the App and SDL via specified transport.
+ *
+ * Takes advantage of the advanced lifecycle management.
+ *
+ * @param listener Reference to the object in the App listening to callbacks from SDL.
+ * @param sdlProxyConfigurationResources Proxy configuration resources.
+ * @param appName Name of the application displayed on SDL.
+ * @param ttsName TTS name.
+ * @param ngnMediaScreenAppName Name of the application displayed on SDL for Navigation equipped
+ * vehicles. Limited to five characters.
+ * @param vrSynonyms A vector of strings, all of which can be used as voice commands too
+ * @param isMediaApp Indicates if the app is a media application.
+ * @param sdlMsgVersion Indicates the version of SDL SmartDeviceLink Messages desired. Must be less than
+ * or equal to the version of SDL SmartDeviceLink running on the vehicle.
+ * @param languageDesired Indicates the language desired for the SDL interface.
+ * @param hmiDisplayLanguageDesired Desired language in HMI.
+ * @param appType Type of application.
+ * @param appID Identifier of the client application.
+ * @param autoActivateID ID used to re-register previously registered application.
+ * @param callbackToUIThread If true, all callbacks will occur on the UI thread.
+ * @param preRegister Flag that indicates that client should be pre-registred or not
+ * @throws SdlException
+ */
+ @Deprecated
+ public SdlProxyALM(IProxyListenerALM listener, SdlProxyConfigurationResources sdlProxyConfigurationResources,
+ String appName, Vector<TTSChunk> ttsName, String ngnMediaScreenAppName, Vector<String> vrSynonyms, Boolean isMediaApp,
+ SdlMsgVersion sdlMsgVersion, Language languageDesired, Language hmiDisplayLanguageDesired,
+ Vector<AppHMIType> appType, String appID, String autoActivateID, boolean callbackToUIThread, boolean preRegister) throws SdlException {
+ super( listener,
+ sdlProxyConfigurationResources,
+ /*enable advanced lifecycle management*/true,
+ appName,
+ ttsName,
+ ngnMediaScreenAppName,
+ vrSynonyms,
+ isMediaApp,
+ sdlMsgVersion,
+ languageDesired,
+ /*HMI Display Language Desired*/hmiDisplayLanguageDesired,
+ /*App Type*/appType,
+ /*App ID*/appID,
+ autoActivateID,
+ callbackToUIThread,
+ preRegister,
+ new BTTransportConfig());
+
+ SdlTrace.logProxyEvent("Application constructed SdlProxyALM (using legacy constructor for BT transport) instance passing in: IProxyListener, sdlProxyConfigurationResources, " +
+ "appName, ngnMediaScreenAppName, vrSynonyms, isMediaApp, sdlMsgVersion, languageDesired, appType, appID, autoActivateID, " +
+ "callbackToUIThread and version", SDL_LIB_TRACE_KEY);
+ }
/**
* Constructor for the SdlProxy object, the proxy for communicating between the App and SDL via specified transport.
*
* Takes advantage of the advanced lifecycle management.
*
+ * @param context - Used to create a multiplexing transport config
* @param listener Reference to the object in the App listening to callbacks from SDL.
* @param sdlProxyConfigurationResources Proxy configuration resources.
* @param appName Name of the application displayed on SDL.
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/SdlProxyBase.java b/sdl_android_lib/src/com/smartdevicelink/proxy/SdlProxyBase.java index 470cb6a14..b8a7a17f4 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/SdlProxyBase.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/SdlProxyBase.java @@ -1784,13 +1784,13 @@ public abstract class SdlProxyBase<proxyListenerType extends IProxyListenerBase> if (_bAppResumeEnabled)
{
- if ( (msg.getResultCode() == Result.RESUME_FAILED) || (msg.getResultCode() != Result.SUCCESS) )
+ if ( (_sdlMsgVersion.getMajorVersion() > 2) && (_lastHashID != null) && (msg.getSuccess()) && (msg.getResultCode() != Result.RESUME_FAILED) )
+ _bResumeSuccess = true;
+ else
{
_bResumeSuccess = false;
_lastHashID = null;
}
- else if ( (_sdlMsgVersion.getMajorVersion() > 2) && (_lastHashID != null) && (msg.getResultCode() == Result.SUCCESS) )
- _bResumeSuccess = true;
}
_diagModes = msg.getSupportedDiagModes();
@@ -1937,15 +1937,15 @@ public abstract class SdlProxyBase<proxyListenerType extends IProxyListenerBase> if (_bAppResumeEnabled)
{
- if ( (msg.getResultCode() == Result.RESUME_FAILED) || (msg.getResultCode() != Result.SUCCESS) )
+ if ( (_sdlMsgVersion.getMajorVersion() > 2) && (_lastHashID != null) && (msg.getSuccess()) && (msg.getResultCode() != Result.RESUME_FAILED) )
+ _bResumeSuccess = true;
+ else
{
_bResumeSuccess = false;
_lastHashID = null;
}
- else if ( (_sdlMsgVersion.getMajorVersion() > 2) && (_lastHashID != null) && (msg.getResultCode() == Result.SUCCESS) )
- _bResumeSuccess = true;
- }
-
+ }
+
_diagModes = msg.getSupportedDiagModes();
if (!isDebugEnabled())
@@ -3599,6 +3599,15 @@ public abstract class SdlProxyBase<proxyListenerType extends IProxyListenerBase> }
}
+ /**
+ * Opens the video service (serviceType 11) and creates a Surface (used for streaming video) with input parameters provided by the app
+ * @param frameRate - specified rate of frames to utilize for creation of Surface
+ * @param iFrameInterval - specified interval to utilize for creation of Surface
+ * @param width - specified width to utilize for creation of Surface
+ * @param height - specified height to utilize for creation of Surface
+ * @param bitrate - specified bitrate to utilize for creation of Surface
+ *@return Surface if service is opened successfully and stream is started, return null otherwise
+ */
public Surface createOpenGLInputSurface(int frameRate, int iFrameInterval, int width,
int height, int bitrate) {
@@ -3627,6 +3636,9 @@ public abstract class SdlProxyBase<proxyListenerType extends IProxyListenerBase> }
}
+ /**
+ *Starts the MediaCodec encoder utilized in conjunction with the Surface returned via the createOpenGLInputSurface method
+ */
public void startEncoder () {
if (sdlSession == null) return;
SdlConnection sdlConn = sdlSession.getSdlConnection();
@@ -3635,6 +3647,9 @@ public abstract class SdlProxyBase<proxyListenerType extends IProxyListenerBase> sdlConn.startEncoder();
}
+ /**
+ *Releases the MediaCodec encoder utilized in conjunction with the Surface returned via the createOpenGLInputSurface method
+ */
public void releaseEncoder() {
if (sdlSession == null) return;
SdlConnection sdlConn = sdlSession.getSdlConnection();
@@ -3643,6 +3658,9 @@ public abstract class SdlProxyBase<proxyListenerType extends IProxyListenerBase> sdlConn.releaseEncoder();
}
+ /**
+ *Releases the MediaCodec encoder utilized in conjunction with the Surface returned via the createOpenGLInputSurface method
+ */
public void drainEncoder(boolean endOfStream) {
if (sdlSession == null) return;
SdlConnection sdlConn = sdlSession.getSdlConnection();
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/SdlProxyBuilder.java b/sdl_android_lib/src/com/smartdevicelink/proxy/SdlProxyBuilder.java index 478b59db6..fd06641c6 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/SdlProxyBuilder.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/SdlProxyBuilder.java @@ -10,7 +10,10 @@ import com.smartdevicelink.proxy.rpc.enums.AppHMIType; import com.smartdevicelink.proxy.rpc.enums.Language; import com.smartdevicelink.transport.BTTransportConfig; import com.smartdevicelink.transport.BaseTransportConfig; +import com.smartdevicelink.transport.MultiplexTransportConfig; + import android.app.Service; +import android.content.Context; public class SdlProxyBuilder { @@ -42,6 +45,7 @@ public class SdlProxyBuilder private String appId; private String appName; private Boolean isMediaApp; + private Context context; // Optional parameters - initialized to default values private Service service = null; @@ -57,16 +61,32 @@ public class SdlProxyBuilder private boolean callbackToUIThread = false; private boolean preRegister = false; private String sAppResumeHash = null; - private BaseTransportConfig mTransport = new BTTransportConfig(); + private BaseTransportConfig mTransport; //Initialized in constructor + + /** + * @deprecated Use Builder(IProxyListenerALM, String, String, Boolean, Context) instead + */ + @Deprecated public Builder(IProxyListenerALM listener, String appId, String appName, Boolean isMediaApp) { this.listener = listener; this.appId = appId; this.appName = appName; this.isMediaApp = isMediaApp; + this.mTransport = new BTTransportConfig(); } - + + public Builder(IProxyListenerALM listener, String appId, String appName, Boolean isMediaApp, Context context) + { + this.listener = listener; + this.appId = appId; + this.appName = appName; + this.isMediaApp = isMediaApp; + this.context = context; + this.mTransport = new MultiplexTransportConfig(context, appId); + } + public Builder setService(Service val) { service = val; return this; } public Builder setSdlProxyConfigurationResources(SdlProxyConfigurationResources val) diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddCommand.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddCommand.java index 3ecac23c5..57b58ea5b 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddCommand.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddCommand.java @@ -8,24 +8,24 @@ import com.smartdevicelink.proxy.RPCRequest; import com.smartdevicelink.util.DebugTool;
/**
-* <p>
-* This class will add a command to the application's Command Menu
-* </p>
-* <p>
-* <b>Note:</b> A command will be added to the end of the list of elements in
-* the Command Menu under the following conditions:
-* </p>
+*
+* <p>This class will add a command to the application's Command Menu</p>
+*
+*
+* <p><b>Note:</b> A command will be added to the end of the list of elements in
+* the Command Menu under the following conditions:</p>
+*
* <ul>
* <li>When a Command is added with no MenuParams value provided</li>
* <li>When a MenuParams value is provided with a MenuParam.position value
* greater than or equal to the number of menu items currently defined in the
* menu specified by the MenuParam.parentID value</li>
* </ul>
-* <br/>
-* <p>
-* The set of choices which the application builds using AddCommand can be a
-* mixture of:
-* </p>
+*
+*
+* <p>The set of choices which the application builds using AddCommand can be a
+* mixture of:</p>
+*
* <ul>
* <li>Choices having only VR synonym definitions, but no MenuParams definitions
* </li>
@@ -33,10 +33,53 @@ import com.smartdevicelink.util.DebugTool; * </li>
* <li>Choices having both MenuParams and VR synonym definitions</li>
* </ul>
-* <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b>
-* </p>
*
+* <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b></p>
+*
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>cmdID</td>
+ * <td> Integer</td>
+ * <td>unique ID of the command to add</td>
+ * <td>Y</td>
+ * <td> minvalue:0; maxvalue:2000000000</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * <tr>
+ * <td>menuParams</td>
+ * <td>ButtonName</td>
+ * <td>Name of the button to unsubscribe.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * <tr/>
+ * <tr>
+ * <td>vrCommands</td>
+ * <td>String</td>
+ * <td><p>An array of strings to be used as VR synonyms for this command.</p> <p>If this array is provided, it may not be empty.</p></td>
+ * <td>N</td>
+ * <td>minsize:1; maxsize:100</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * <tr>
+ * <td>cmdIcon</td>
+ * <td>Image</td>
+ * <td><p>Image struct determining whether static or dynamic icon.</p><p>If omitted on supported displays, no (or the default if applicable) icon shall be displayed.</p></td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+* </table>
+* <p> <b>Response</b></p><p>Indicates that the corresponding request has failed or succeeded, if the response returns with a SUCCESS result code, this means a command was added to the Command Menu successfully.</p>
+*
+* <p><b>Non-default Result Codes:</b></p> <p>INVALID_ID</p> <p>DUPLICATE_NAME</p>
* @since SmartDeviceLink 1.0
* @see DeleteCommand
* @see AddSubMenu
@@ -79,15 +122,15 @@ public class AddCommand extends RPCRequest { return (Integer) parameters.get(KEY_CMD_ID);
}
/**
- * Sets an Unique Command ID that identifies the command. Is returned in an
+ * <p>Sets an Unique Command ID that identifies the command. Is returned in an
* <i>{@linkplain OnCommand}</i> notification to identify the command
- * selected by the user
- * <p>
+ * selected by the user</p>
+ *
*
* @param cmdID
* an integer object representing a Command ID
* <p>
- * <b>Notes:</b> Min Value: 0; Max Value: 2000000000
+ * <b>Notes:</b> Min Value: 0; Max Value: 2000000000</p>
*/
public void setCmdID(Integer cmdID) {
if (cmdID != null) {
@@ -103,6 +146,7 @@ public class AddCommand extends RPCRequest { * </p>
*
* @return MenuParams -a MenuParams object
+ *
*/
@SuppressWarnings("unchecked")
public MenuParams getMenuParams() {
@@ -121,9 +165,9 @@ public class AddCommand extends RPCRequest { }
/**
* <p>
- * Sets Menu parameters<br/>
+ * Sets Menu parameters</p>
* If provided, this will define the command and how it is added to the
- * Command Menu<br/>
+ * Command Menu<p>
* If null, commands will not be accessible through the HMI application menu
* </p>
*
@@ -159,11 +203,11 @@ public class AddCommand extends RPCRequest { }
/**
* <p>
- * Sets Voice Recognition Commands <br/>
- * If provided, defines one or more VR phrases the recognition of any of
+ * Sets Voice Recognition Commands </p>
+ * <p>If provided, defines one or more VR phrases the recognition of any of
* which triggers the <i>{@linkplain OnCommand}</i> notification with this
- * cmdID<br/>
- * If null, commands will not be accessible by voice commands (when the user
+ * cmdID</p>
+ * <p>If null, commands will not be accessible by voice commands (when the user
* hits push-to-talk)
* </p>
*
@@ -172,7 +216,7 @@ public class AddCommand extends RPCRequest { * <p>
* <b>Notes: </b>Optional only if menuParams is provided. If
* provided, array must contain at least one non-empty (not null,
- * not zero-length, not whitespace only) element
+ * not zero-length, not whitespace only) element</p>
*/
public void setVrCommands( List<String> vrCommands ) {
if (vrCommands != null) {
@@ -183,7 +227,7 @@ public class AddCommand extends RPCRequest { }
/**
- * Gets the image to be shown along with a command </p>
+ * <p>Gets the image to be shown along with a command </p>
*
* @return Image -an Image object
* @since SmartDeviceLink 2.0
@@ -204,14 +248,14 @@ public class AddCommand extends RPCRequest { }
/**
- * Sets the Image<br/>
- * If provided, defines the image to be be shown along with a command
+ * <p>Sets the Image
+ * If provided, defines the image to be be shown along with a command</p>
* @param cmdIcon
- * an Image obj representing the Image obj shown along with a
- * command
+ * <p>an Image obj representing the Image obj shown along with a
+ * command</p>
* <p>
* <b>Notes: </b>If omitted on supported displays, no (or the
- * default if applicable) icon will be displayed
+ * default if applicable) icon will be displayed</p>
* @since SmartDeviceLink 2.0
*/
public void setCmdIcon(Image cmdIcon) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddCommandResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddCommandResponse.java index 5d64cf6c8..da908908b 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddCommandResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddCommandResponse.java @@ -11,7 +11,9 @@ import com.smartdevicelink.proxy.RPCResponse; * @since SmartDeviceLink 1.0
*/
public class AddCommandResponse extends RPCResponse {
-
+ /**
+ * Constructs a new AddCommandResponse object
+ */
public AddCommandResponse() {
super(FunctionID.ADD_COMMAND.toString());
}
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddSubMenu.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddSubMenu.java index 9985fab61..2edc70c50 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddSubMenu.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddSubMenu.java @@ -6,15 +6,55 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCRequest;
/**
- * Add a SubMenu to the Command Menu
- * <p>
- * A SubMenu can only be added to the Top Level Menu (i.e.a SunMenu cannot be
- * added to a SubMenu), and may only contain commands as children
- * <p>
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b>
- * </p>
+ * <p>Add a SubMenu to the Command Menu</p>
*
+ * <p>A SubMenu can only be added to the Top Level Menu (i.e.a SubMenu cannot be
+ * added to a SubMenu), and may only contain commands as children</p>
+ *
+ *
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b></p>
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>menuID</td>
+ * <td>Integer</td>
+ * <td>Unique ID that identifies this sub menu. This value is used in AddCommand to which SubMenu is the parent of the command being added.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>position</td>
+ * <td>Integer</td>
+ * <td>Position within the items of the top level Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. Position of any submenu will always be located before the return and exit options.</td>
+ * <td>N</td>
+ * <td>Min Value: 0 <p>Max Value: 1000</p> <p>If position is greater or equal than the number of items on top level, the sub menu will be appended by the end.</p><p>If this parameter is omitted, the entry will be added at the end of the list.</P></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>menuName</td>
+ * <td>String</td>
+ * <td>Text which is displayed representing this submenu item</td>
+ * <td>Y</td>
+ * <td>maxlength:500</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * </table>
+ * <b>Response</b>
+ * <p>Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code, this means the SubMenu was added to the Command Menu successfully</p>
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>INVALID_ID</p>
+ * <p>DUPLICATE NAME</p>
* @since SmartDeviceLink 1.0
* @see DeleteSubMenu
* @see AddCommand
@@ -33,7 +73,7 @@ public class AddSubMenu extends RPCRequest { }
/**
* Constructs a new AddSubMenu object indicated by the Hashtable parameter
- * <p>
+ *
*
* @param hash
* The Hashtable to use
@@ -44,7 +84,7 @@ public class AddSubMenu extends RPCRequest { /**
* Returns an <i>Integer</i> object representing the Menu ID that identifies
* a sub menu
- * <p>
+ *
*
* @return Integer -an integer representing the Menu ID that identifies a sub
* menu
@@ -53,15 +93,15 @@ public class AddSubMenu extends RPCRequest { return (Integer) parameters.get( KEY_MENU_ID );
}
/**
- * Sets a Menu ID that identifies a sub menu. This value is used in
+ * <p>Sets a Menu ID that identifies a sub menu.</p><p> This value is used in
* {@linkplain AddCommand} to which SubMenu is the parent of the command
- * being added
- * <p>
+ * being added</p>
+ *
*
* @param menuID
* an integer object representing a Menu ID
- * <p>
- * <b>Notes:</b> Min Value: 0; Max Value: 2000000000
+ *
+ * <p><b>Notes:</b> Min Value: 0; Max Value: 2000000000</p>
*/
public void setMenuID( Integer menuID ) {
if (menuID != null) {
@@ -71,8 +111,8 @@ public class AddSubMenu extends RPCRequest { }
}
/**
- * Returns an <i>Integer</i> object representing the position of menu
- * <p>
+ * <p>Returns an <i>Integer</i> object representing the position of menu</p>
+ *
*
* @return Integer -the value representing the relative position of menus
*/
@@ -83,17 +123,17 @@ public class AddSubMenu extends RPCRequest { * Sets a position of menu
*
* @param position
- * An Integer object representing the position within the items
+ * <p>An Integer object representing the position within the items
* of the top level Command Menu. 0 will insert at the front, 1
* will insert after the first existing element, etc. Position of
* any submenu will always be located before the return and exit
* options
- * <p>
- * <b>Notes: </b><br/>
+ * </p>
+ * <b>Notes: </b>
* <ul>
* <li>
* Min Value: 0; Max Value: 1000</li>
- * <li>If position is greater or equal than the number of items
+ * <li>If position is greater than or equal to the number of items
* on top level, the sub menu will be appended by the end</li>
* <li>If this parameter is omitted, the entry will be added at
* the end of the list</li>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddSubMenuResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddSubMenuResponse.java index c43317628..6b386eef5 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddSubMenuResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddSubMenuResponse.java @@ -10,6 +10,9 @@ import com.smartdevicelink.proxy.RPCResponse; * @since SmartDeviceLink 1.0
*/
public class AddSubMenuResponse extends RPCResponse {
+ /**
+ * Constructs a new AddSubMenuResponse object
+ */
public AddSubMenuResponse() {
super(FunctionID.ADD_SUB_MENU.toString());
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AirbagStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AirbagStatus.java index 13028f257..b80a9c2c4 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AirbagStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AirbagStatus.java @@ -4,7 +4,83 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.VehicleDataEventStatus;
-
+/**
+ * <p>The status of the air bags.</p>
+ *
+ *
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Version.</th>
+ * </tr>
+ * <tr>
+ * <td>driverAirbagDeployed </td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>Status of driver airbag.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>driverSideAirbagDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>Status of driver side airbag.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>driverCurtainAirbagDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>Status of driver curtain airbag.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>passengerAirbagDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>Status of passenger airbag.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>passengerCurtainAirbagDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>Status of passenger curtain airbag.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>driverKneeAirbagDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>Status of driver knee airbag.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>passengerSideAirbagDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>Status of passenger side airbag.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>passengerKneeAirbagDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>Status of passenger knee airbag</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ *
+ * </table>
+ *
+ * <p><b>Response:</b></p>
+ * If a resultCode of "SUCCESS" is returned, the request was accepted by SDL. By the time the corresponding response is received, the Alert will have completed.
+ *
+ * <p><b> Non-default Result Codes:</b></p>
+ * <p>REJECTED</p><p> ABORTED</P>
+ *
+ *
+ * @since SmartDeviceLink 1.0
+ *
+ * @see TextFieldName
+ * @see Image
+ * @see SubscribeVehicleData
+ */
public class AirbagStatus extends RPCStruct {
public static final String KEY_DRIVER_AIRBAG_DEPLOYED = "driverAirbagDeployed";
public static final String KEY_DRIVER_SIDE_AIRBAG_DEPLOYED = "driverSideAirbagDeployed";
@@ -14,6 +90,13 @@ public class AirbagStatus extends RPCStruct { public static final String KEY_PASSENGER_SIDE_AIRBAG_DEPLOYED = "passengerSideAirbagDeployed";
public static final String KEY_PASSENGER_CURTAIN_AIRBAG_DEPLOYED = "passengerCurtainAirbagDeployed";
public static final String KEY_PASSENGER_KNEE_AIRBAG_DEPLOYED = "passengerKneeAirbagDeployed";
+ /** Constructs a new AirbagStatus object indicated by the Hashtable
+ * parameter
+ * @param hash
+ * The hash table to use
+ *
+ *
+ */
public AirbagStatus() { }
public AirbagStatus(Hashtable<String, Object> hash) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Alert.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Alert.java index dad62cad5..811d65a42 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Alert.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Alert.java @@ -10,7 +10,7 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* Provides information to the user using either TTS, the Display or both and
* can include a system-generated alert tone
- * <p>
+ *
* <ul>
* <li>The displayed portion of the Alert, if any, will persist until the
* specified timeout has elapsed, or the Alert is preempted</li>
@@ -20,7 +20,7 @@ import com.smartdevicelink.proxy.RPCRequest; * <li>An Alert can be preempted by a user action (button push)</li>
* <li>An Alert will fail if it is issued while another Alert is in progress</li>
* <li>Although each Alert parameter is optional, in fact each Alert request
- * must supply at least one of the following parameters:<br/>
+ * must supply at least one of the following parameters:
* <ul>
* <li>alertText1</li>
* <li>alertText2</li>
@@ -29,12 +29,89 @@ import com.smartdevicelink.proxy.RPCRequest; * </ul>
* </li>
* </ul>
- * <br/>
- * <b>HMILevel needs to be FULL or LIMITED.</b><br/>
- * <b>If the app has been granted function group Notification the HMILevel can
- * also be BACKGROUND</b><br/>
*
+ * <p><b>HMILevel needs to be FULL or LIMITED.</b></p>
+ * <b>If the app has been granted function group Notification the HMILevel can
+ * also be BACKGROUND</b>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>alertText1</td>
+ * <td>String</td>
+ * <td>Text to be displayed in the first field of the display during the Alert. </td>
+ * <td>N</td>
+ * <td> Length is limited to what is indicated in RegisterAppInterface response. If omitted, top display line will be cleared. Text is always centered</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>alertText2</td>
+ * <td>String</td>
+ * <td>Text to be displayed in the second field of the display during the Alert. </td>
+ * <td>N</td>
+ * <td> Only permitted if HMI supports a second display line. Length is limited to what is indicated in RegisterAppInterface response. If omitted, second display line will be cleared. </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>alertText3</td>
+ * <td>String</td>
+ * <td>Text to be displayed in the third field of the display during the Alert.</td>
+ * <td>N</td>
+ * <td>Array must have a least one element. </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>ttsChunks</td>
+ * <td>TTSChunk[]</td>
+ * <td>Array of type TTSChunk which, taken together, specify what is to be spoken to the user.</td>
+ * <td>N</td>
+ * <td>Array must have a least one element. </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>duration</td>
+ * <td>Integer</td>
+ * <td><p>The duration of the displayed portion of the alert, in milliseconds.</p> After this amount of time has passed, the display fields alertText1 and alertText2 will revert to what was displayed in those fields before the alert began.</td>
+ * <td>N</td>
+ * <td>Min Value: 3000 Max Value: 10000 <p>If omitted, the default is 5000 milliseconds</p></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>playTone</td>
+ * <td>Boolean</td>
+ * <td>Specifies whether the alert tone should be played before the TTS (if any) is spoken.</td>
+ * <td>N</td>
+ * <td>If omitted, default is true.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>softButtons</td>
+ * <td>SoftButton[]</td>
+ * <td>Specifies the softbuttons, the apps wants to use in this alert.</td>
+ * <td></td>
+ * <td>If omitted on supported displays, the alert will not have any SoftButton.ArrayMin: 0; ArrayMax: 4</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>progressIndicator</td>
+ * <td>Boolean</td>
+ * <td>If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc.</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * </table>
* @since SmartDeviceLink 1.0
+ *
+ *
+ * @see GetVehicleData
+ * @see OnVehicleData
* @see Show
* @see Speak
*/
@@ -55,8 +132,8 @@ public class Alert extends RPCRequest { super(FunctionID.ALERT.toString());
}
/**
- * Constructs a new Alert object indicated by the Hashtable parameter
- * <p>
+ * <p>Constructs a new Alert object indicated by the Hashtable parameter</p>
+ *
*
* @param hash
* The Hashtable to use
@@ -80,8 +157,8 @@ public class Alert extends RPCRequest { *
* @param alertText1
* String Value
- * <p>
- * <b>Notes: </b><br/>
+ *
+ * <p><b>Notes: </b></p>
* <ul>
* <li>Length is limited to what is indicated in <i>
* {@linkplain RegisterAppInterface}</i> response</li>
@@ -112,8 +189,8 @@ public class Alert extends RPCRequest { *
* @param alertText2
* String Value
- * <p>
- * <b>Notes: </b><br/>
+ *
+ * <p><b>Notes: </b></p>
* <ul>
* <li>Only permitted if HMI supports a second display line</li>
* <li>Length is limited to what is indicated in <i>
@@ -149,8 +226,8 @@ public class Alert extends RPCRequest { *
* @param alertText3
* String Value
- * <p>
- * <b>Notes: </b><br/>
+ *
+ * <p> <b>Notes: </b></p>
* <ul>
* <li>Only permitted if HMI supports a third display line</li>
* <li>Length is limited to what is indicated in <i>
@@ -199,8 +276,8 @@ public class Alert extends RPCRequest { * spoken to the user
*
* @param ttsChunks
- * <p>
- * <b>Notes: </b>Array must have a least one element
+ *
+ * <p> <b>Notes: </b>Array must have a least one element</p>
*/
public void setTtsChunks(List<TTSChunk> ttsChunks) {
if (ttsChunks != null) {
@@ -219,17 +296,17 @@ public class Alert extends RPCRequest { return (Integer) parameters.get(KEY_DURATION);
}
/**
- * Sets the duration of the displayed portion of the alert, in milliseconds.
+ * <p>Sets the duration of the displayed portion of the alert, in milliseconds.
* After this amount of time has passed, the display fields alertText1 and
* alertText2 will revert to what was displayed in those fields before the
- * alert began
- * <p>
+ * alert began</p>
+ *
*
* @param duration
* the Integer values representing the duration time, in
* milliseconds
* <p>
- * <b>Notes: </b><br/>
+ * <b>Notes: </b></p>
* <ul>
* <li>Min Value: 3000; Max Value: 10000</li>
* <li>If omitted, the default is 5000 milliseconds</li>
@@ -258,8 +335,8 @@ public class Alert extends RPCRequest { * @param playTone
* a Boolean value which specifies whether the alert tone should
* be played before the TTS (if any) is spoken
- * <p>
- * <b>Notes: </b>If omitted, default is true
+ *
+ * <p> <b>Notes: </b>If omitted, default is true</p>
*/
public void setPlayTone(Boolean playTone) {
if (playTone != null) {
@@ -302,7 +379,7 @@ public class Alert extends RPCRequest { * @param softButtons
* a List<SoftButton> value
* <p>
- * <b>Notes: </b><br/>
+ * <b>Notes: </b></p>
* <ul>
* <li>If omitted on supported displays, the alert will not have
* any SoftButton</li>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AlertManeuver.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AlertManeuver.java index 9aab52589..fba595150 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AlertManeuver.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AlertManeuver.java @@ -8,13 +8,13 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCRequest; /** - * This will bring up an alert with information related to the next navigation maneuver including potential voice + * <p>This will bring up an alert with information related to the next navigation maneuver including potential voice * navigation instructions. Shown information will be taken from the ShowConstantTBT function - * <p> - * Function Group: Navigation - * <p> - * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> - * <p> + * </p> + * <p>Function Group: Navigation</p> + * + * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p> + * * * @since SmartDeviceLink 2.0 * @see ShowConstantTbt @@ -32,9 +32,9 @@ public class AlertManeuver extends RPCRequest{ } /** - * <p> - * Constructs a new AlertManeuver object indicated by the Hashtable parameter - * </p> + * + * <p>Constructs a new AlertManeuver object indicated by the Hashtable parameter</p> + * * * @param hash * The Hashtable to use @@ -76,7 +76,7 @@ public class AlertManeuver extends RPCRequest{ * @param softButtons * a List<SoftButton> value * <p> - * <b>Notes: </b><br/> + * <b>Notes: </b></p> * <ul> * <li>If omitted on supported displays, the alert will not have any SoftButton</li> * <li>ArrayMin: 0</li> @@ -125,7 +125,7 @@ public class AlertManeuver extends RPCRequest{ * * @param ttsChunks * <p> - * <b>Notes: </b>Array must have a least one element + * <b>Notes: </b></p>Array must have a least one element */ public void setTtsChunks(List<TTSChunk> ttsChunks){ if(ttsChunks != null){ diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AlertResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AlertResponse.java index fc01fbe63..cea706d4e 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AlertResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AlertResponse.java @@ -21,9 +21,9 @@ public class AlertResponse extends RPCResponse { }
/**
- * Constructs a new AlertResponse object indicated by the Hashtable
+ * <p>Constructs a new AlertResponse object indicated by the Hashtable
* parameter
- * <p>
+ * </p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java index 0db1c6c8b..48cfd129b 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java @@ -8,8 +8,10 @@ import com.smartdevicelink.proxy.rpc.enums.BitsPerSample; import com.smartdevicelink.proxy.rpc.enums.SamplingRate;
/**
- * Describes different audio type configurations for PerformAudioPassThru, e.g. {8kHz,8-bit,PCM}
- * <p><b>Parameter List
+ *<p> Describes different audio type configurations for PerformAudioPassThru, e.g. {8kHz,8-bit,PCM}
+ * Specifies the capabilities of audio capturing: sampling rate, bits per sample, audio type.</p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -39,6 +41,8 @@ import com.smartdevicelink.proxy.rpc.enums.SamplingRate; * <td>SmartDeviceLink 2.0</td>
* </tr>
* </table>
+ * @see ButtonName
+ * @see GetCapabilities
* @since SmartDeviceLink 2.0
*/
public class AudioPassThruCapabilities extends RPCStruct {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/BeltStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/BeltStatus.java index ccf15c855..71db21640 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/BeltStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/BeltStatus.java @@ -4,6 +4,114 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.VehicleDataEventStatus;
+/** The status of the seat belts.
+ *
+ * <p><b>Parameter List</b></p>
+ *
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Mandatory</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td>driverBeltDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The driver seat belt is deployed.</td>
+ * </tr>
+ * <tr>
+ * <td>passengerBeltDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The passenger seat belt is deployed.</td>
+ * </tr>
+ * <tr>
+ * <td>passengerBuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The passenger seat belt is buckled.</td>
+ * </tr>
+ * <tr>
+ * <td>driverBuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The driver seat belt is buckled.</td>
+ * </tr>
+ * <tr>
+ * <td>leftRow2BuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The left seat belt of the 2nd row is buckled.</td>
+ * </tr>
+ * <tr>
+ * <td>passengerChildDetected</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The child passenger is detected.</td>
+ * </tr>
+ * <tr>
+ * <td>rightRow2BuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The right seat belt of the 2nd row is buckled.</td>
+ * </tr>
+ * <tr>
+ * <td>middleRow2BuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The middle seat belt of the 2nd row is buckled.</td>
+ * </tr>
+ * <tr>
+ * <td>middleRow3BuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The middle seat belt of the 3rd row is buckled.</td>
+ * </tr>
+ * <tr>
+ * <td>leftRow3BuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The left seat belt of the 3rd row is buckled.</td>
+ * </tr>
+ * <tr>
+ * <td>rightRow3BuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The right seat belt of the 3rd row is buckled.</td>
+ * </tr>
+ * <tr>
+ * <td>leftRearInflatableBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The left rear inflatable is belted.</td>
+ * </tr>
+ * <tr>
+ * <td>rightRearInflatableBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The right rear inflatable is belted.</td>
+ * </tr>
+ * <tr>
+ * <td>middleRow1BeltDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The seat belt of the middle row is deployed.</td>
+ * </tr>
+ * <tr>
+ * <td>middleRow1BuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The seat belt of the middle row is buckled.</td>
+ * </tr>
+ * </table>
+* @since SmartDeviceLink 2.0
+* @see VehicleDataEventStatus
+* @see GetVehicleData
+* @see OnVehicleData
+ * @see SubscribeVehicleData
+ */
public class BeltStatus extends RPCStruct {
public static final String KEY_DRIVER_BELT_DEPLOYED = "driverBeltDeployed";
@@ -21,6 +129,13 @@ public class BeltStatus extends RPCStruct { public static final String KEY_RIGHT_REAR_INFLATABLE_BELTED = "rightRearInflatableBelted";
public static final String KEY_MIDDLE_ROW_1_BELT_DEPLOYED = "middleRow1BeltDeployed";
public static final String KEY_MIDDLE_ROW_1_BUCKLE_BELTED = "middleRow1BuckleBelted";
+ /** Constructs a new BeltStatus object indicated by the Hashtable
+ * parameter
+ * @param hash
+ * The hash table to use
+ *
+ *
+ */
public BeltStatus() { }
public BeltStatus(Hashtable<String, Object> hash) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/BodyInformation.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/BodyInformation.java index 5b9b984d8..038b1970e 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/BodyInformation.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/BodyInformation.java @@ -5,6 +5,83 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.IgnitionStableStatus;
import com.smartdevicelink.proxy.rpc.enums.IgnitionStatus;
+/** The body information including power modes.
+ *
+ * <p><b>Note:</b> The structure defines the information about the park brake and ignition.</p>
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Mandatory</th>
+ * <th>Description</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>parkBrakeActive</td>
+ * <td>Boolean</td>
+ * <td>true</td>
+ * <td>Describes, if the parkbreak is active. The information about the park brake: - true, if active - false if not.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>ignitionStableStatus</td>
+ * <td>IgnitionStableStatus</td>
+ * <td>true</td>
+ * <td>Describes, if the ignition situation is considered stableThe information about stability of the ignition switch. See {@linkplain IgnitionStableStatus}</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>ignitionStatus</td>
+ * <td>IgnitionStatus</td>
+ * <td>true</td>
+ * <td>The information about ignition status. See {@linkplain IgnitionStatus}</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>parkBrakeActive</td>
+ * <td>Boolean</td>
+ * <td>true</td>
+ * <td>The information about the park brake: - true, if active - false if not.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>driverDoorAjar</td>
+ * <td>Boolean</td>
+ * <td>true</td>
+ * <td>The information about the park brake: - true, if active - false if not.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>passengerDoorAjar</td>
+ * <td>Boolean</td>
+ * <td>true</td>
+ * <td>The information about the park brake: - true, if active - false if not.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>rearLeftDoorAjar</td>
+ * <td>Boolean</td>
+ * <td>true</td>
+ * <td>The information about the park brake: - true, if active - false if not.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>rearRightDoorAjar</td>
+ * <td>Boolean</td>
+ * <td>true</td>
+ * <td>References signal "DrStatRr_B_Actl".</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ *
+ * </table>
+ * @since SmartDeviceLink 2.0
+ * @see SubscribeVehicleData
+ * @see GetVehicleData
+ * @see OnVehicleData
+ *
+ */
public class BodyInformation extends RPCStruct {
public static final String KEY_PARK_BRAKE_ACTIVE = "parkBrakeActive";
@@ -14,6 +91,13 @@ public class BodyInformation extends RPCStruct { public static final String KEY_PASSENGER_DOOR_AJAR = "passengerDoorAjar";
public static final String KEY_REAR_LEFT_DOOR_AJAR = "rearLeftDoorAjar";
public static final String KEY_REAR_RIGHT_DOOR_AJAR = "rearRightDoorAjar";
+ /** Constructs a new BodyInformation object indicated by the Hashtable
+ * parameter
+ * @param hash
+ * The hash table to use
+ *
+ *
+ */
public BodyInformation() { }
public BodyInformation(Hashtable<String, Object> hash) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java index f59848036..9b15c5be9 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java @@ -7,7 +7,7 @@ import com.smartdevicelink.proxy.rpc.enums.ButtonName; /**
* Provides information about the capabilities of a SDL HMI button.
- * <p><b> Parameter List
+ * <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -24,24 +24,40 @@ import com.smartdevicelink.proxy.rpc.enums.ButtonName; * <tr>
* <td>shortPressAvailable</td>
* <td>Boolean</td>
- * <td>The button supports a SHORT press. See ButtonPressMode for more information.</td>
+ * <td>The button supports a SHORT press. See {@linkplain ButtonPressMode} for more information.</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>longPressAvailable</td>
* <td>Boolean</td>
- * <td>The button supports a LONG press. See ButtonPressMode for more information.</td>
+ * <td>The button supports a LONG press. See {@linkplain ButtonPressMode} for more information.</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>upDownAvailable</td>
* <td>Boolean</td>
* <td>The button supports "button down" and "button up". When the button is depressed, the <i>{@linkplain OnButtonEvent}</i> notification will be invoked with a value of BUTTONDOWN.
- * <p> When the button is released, the <i>{@linkplain OnButtonEvent}</i> notification will be invoked with a value of BUTTONUP.</td>
+ * <p> When the button is released, the <i>{@linkplain OnButtonEvent}</i> notification will be invoked with a value of BUTTONUP.</p></td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* </table>
+ *
+ * <p>Upon the request HMI must provide the list of the following information:</p>
+ * <p>The names of all existing/supported hardware buttons.</p>
+ * <p>The availability of LONG/SHORT press for each existing/supported hardware button correspondingly</p>
+ * <p>The availability of UP/DOWN events for each existing/supported hardware button correspondingly.</p>
+ *
* @since SmartDeviceLink 1.0
+ *
+ * @see ButtonName
+ * @see ButtonEventMode
+ * @see ButtonPressMode
+ *
+ *
+ *
+ * @see OnButtonEvent
+ * @see OnButtonPress
+ *
*/
public class ButtonCapabilities extends RPCStruct {
public static final String KEY_NAME = "name";
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ChangeRegistration.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ChangeRegistration.java index 1cf47841e..2b4c69f42 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ChangeRegistration.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ChangeRegistration.java @@ -9,15 +9,91 @@ import com.smartdevicelink.proxy.RPCRequest; import com.smartdevicelink.proxy.rpc.enums.Language;
/**
- * If the app recognizes during the app registration that the Sdl HMI language
+ * 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
- * <p>
- * Function Group: Base
- * <p>
- * <b>HMILevel can by any</b>
- * <p>
+ * prior to app being brought into focus.
+ *
+ * <p>Function Group: Base</p>
+ *
+ * <p><b>HMILevel can by any</b></p>
+ *
+ * <b>Note:</b>
+ *
+ * <p>SDL will send the language value confirmed to be supported by HMI via UI.GetCapabilities.</p>
+ * <p><b> Parameter List</b></p>
+ *
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>Language</td>
+ * <td>Language</td>
+ * <td>Requested SDL voice engine (VR+TTS) language registration.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>hmiDisplayLanguage</td>
+ * <td>Language</td>
+ * <td>Request display language registration.</td>
+ * <td>Y</td>
+ * <td>Minvalue=0; Maxvalue=2000000000</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ *
+ * <tr>
+ * <td>appName</td>
+ * <td>String</td>
+ * <td>Request new app name registration</td>
+ * <td>N</td>
+ * <td>maxlength:100</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>ttsName</td>
+ * <td>TTSChunk</td>
+ * <td>Request new ttsName registration</td>
+ * <td>N</td>
+ * <td>minsize:1; maxsize:100</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>ngnMediaScreenAppName</td>
+ * <td>String</td>
+ * <td>Request new app short name registration</td>
+ * <td>N</td>
+ * <td>maxlength: 100</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>vrSynonyms</td>
+ * <td>String</td>
+ * <td>Request new VR synonyms registration</td>
+ * <td>N</td>
+ * <td>maxlength: 40; minsize:1; maxsize:100</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * </table>
+ *
+ * <p><b>Response </b></p>
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
+ * <p>DISALLOWED</p>
*
* @since SmartDeviceLink 2.0
* @see RegisterAppInterface
@@ -38,9 +114,9 @@ public class ChangeRegistration extends RPCRequest { }
/**
- * Constructs a new ChangeRegistration object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new ChangeRegistration object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
@@ -222,7 +298,7 @@ public class ChangeRegistration extends RPCRequest { * a List<String> value representing the an array of 1-100
* elements
* <p>
- * <b>Notes: </b>
+ * <b>Notes: </b></p>
* <ul>
* <li>Each vr synonym is limited to 40 characters, and there can
* be 1-100 synonyms in array</li>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ChangeRegistrationResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ChangeRegistrationResponse.java index 0ab62ba49..e5404cad3 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ChangeRegistrationResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ChangeRegistrationResponse.java @@ -20,9 +20,9 @@ public class ChangeRegistrationResponse extends RPCResponse { }
/**
- * Constructs a new ChangeRegistrationResponse object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new ChangeRegistrationResponse object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Choice.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Choice.java index 79f181690..2bc59736e 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Choice.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Choice.java @@ -8,7 +8,8 @@ import com.smartdevicelink.util.DebugTool; /**
* A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction.
- * <p><b> Parameter List
+ * For example, the application may request for the user`s choice among several suggested ones: Yes, No, Skip.
+ * <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -18,10 +19,10 @@ import com.smartdevicelink.util.DebugTool; * </tr>
* <tr>
* <td>choiceID</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>Application-scoped identifier that uniquely identifies this choice.
- * <br/>Min: 0
- * <br/>Max: 65535
+ * Min: 0;
+ * Max: 65535
* </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
@@ -29,8 +30,8 @@ import com.smartdevicelink.util.DebugTool; * <td>menuName</td>
* <td>String</td>
* <td>Text which appears in menu, representing this choice.
- * <br/>Min: 1
- * <br/>Max: 100
+ * Min: 1;
+ * Max: 100
* </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
@@ -49,6 +50,10 @@ import com.smartdevicelink.util.DebugTool; * </table>
*
* @since SmartDeviceLink 1.0
+ *
+ * @see AddCommand
+ * @see PerformInteraction
+ * @see Image
*/
public class Choice extends RPCStruct {
public static final String KEY_SECONDARY_TEXT = "secondaryText";
@@ -71,7 +76,7 @@ public class Choice extends RPCStruct { }
/**
* Get the application-scoped identifier that uniquely identifies this choice.
- * @return choiceID Min: 0 Max: 65535
+ * @return choiceID Min: 0; Max: 65535
*/
public Integer getChoiceID() {
return (Integer) store.get(KEY_CHOICE_ID);
@@ -89,8 +94,8 @@ public class Choice extends RPCStruct { }
/**
* Text which appears in menu, representing this choice.
- * <br/>Min: 1
- * <br/>Max: 100
+ * Min: 1;
+ * Max: 100
* @return menuName the menu name
*/
public String getMenuName() {
@@ -98,8 +103,8 @@ public class Choice extends RPCStruct { }
/**
* Text which appears in menu, representing this choice.
- * <br/>Min: 1
- * <br/>Max: 100
+ * Min: 1;
+ * Max: 100
* @param menuName the menu name
*/
public void setMenuName(String menuName) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java index 6ea37a444..17e16af65 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java @@ -6,12 +6,62 @@ import com.smartdevicelink.proxy.RPCStruct; import com.smartdevicelink.proxy.rpc.enums.CarModeStatus;
import com.smartdevicelink.proxy.rpc.enums.PowerModeQualificationStatus;
import com.smartdevicelink.proxy.rpc.enums.PowerModeStatus;
+/** <p>The status modes of the instrument panel cluster.</p>
+ *
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Mandatory</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td>powerModeActive</td>
+ * <td>Boolean</td>
+ * <td></td>
+ * <td>References signal "PowerMode_UB".</td>
+ * </tr>
+ * <tr>
+ * <td>powerModeQualificationStatus</td>
+ * <td>PowerModeQualificationStatus</td>
+ * <td></td>
+ * <td>References signal "PowerModeQF".</td>
+ * </tr>
+ * <tr>
+ * <td>carModeStatus</td>
+ * <td>CarModeStatus</td>
+ * <td></td>
+ * <td>Describes the carmode the vehicle is in.</td>
+ * </tr>
+ * <tr>
+ * <td>powerModeStatus</td>
+ * <td>PowerModeStatus</td>
+ * <td>true</td>
+ * <td>Describes the different powermodes</td>
+ * </tr>
+ *
+ * </table>
+ * @since SmartDeviceLink 1.0
+ *
+ * @see SubscribeVehicleData
+ * @see SubscribeVehicleData
+ * @see Image
+ *
+ */
public class ClusterModeStatus extends RPCStruct {
public static final String KEY_POWER_MODE_ACTIVE = "powerModeActive";
public static final String KEY_POWER_MODE_QUALIFICATION_STATUS = "powerModeQualificationStatus";
public static final String KEY_CAR_MODE_STATUS = "carModeStatus";
public static final String KEY_POWER_MODE_STATUS = "powerModeStatus";
+ /** <p>Constructs a new ClusterModeStatus object indicated by the Hashtable
+ * parameter</p>
+ * @param hash
+ * The hash table to use
+ *
+ */
public ClusterModeStatus() { }
public ClusterModeStatus(Hashtable<String, Object> hash) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java index 45c2901de..97793558f 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java @@ -10,11 +10,64 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* Creates a Choice Set which can be used in subsequent <i>
* {@linkplain PerformInteraction}</i> Operations.
- * <p>
- * Function Group: Base
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
+ *
+ * <p>Function Group: Base </p>
+ *
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p>AudioStreamingState : ANY</p>
+ *
+ * <p>SystemContext: MAIN, MENU, VR</p>
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>interactionChoiceSetID</td>
+ * <td>Integer</td>
+ * <td>A unique ID that identifies the Choice Set</td>
+ * <td>Y</td>
+ * <td>Min Value: 0; Max Value: 2000000000</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>choiceSet</td>
+ * <td>Choice[]</td>
+ * <td>Array of one or more elements.</td>
+ * <td>Y</td>
+ * <td>Min Value: 1; Max Value: 100</td>
+ * <td>SmartDeviceLink 1.0 </td>
+ * </tr>
+ * </table>
+ *
+ *
+ * <p> <b>Note:</b></p>Second Utterance issue with CreateInteractionChoiceSet RPC. Before a perform interaction
+ * is sent you MUST wait for the success from the CreateInteractionChoiceSet RPC.
+ * If you do not wait the system may not recognize the first utterance from the user.
+ *
+ * <p><b>Response</b></p>
+ *
+ * Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code, this means the Choice Set was created.
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p> REJECTED</p>
+ * <p> INVALID_ID</p>
+ * <p> DUPLICATE_NAME</p>
+ * <p>UNSUPPORTED_RESOURCE </p>
+ *
*
* @since SmartDeviceLink 1.0
* @see DeleteInteractionChoiceSet
@@ -31,9 +84,9 @@ public class CreateInteractionChoiceSet extends RPCRequest { super(FunctionID.CREATE_INTERACTION_CHOICE_SET.toString());
}
/**
- * Constructs a new CreateInteractionChoiceSet object indicated by the
- * Hashtable parameter
- * <p>
+ * <p>Constructs a new CreateInteractionChoiceSet object indicated by the
+ * Hashtable parameter</p>
+ *
*
* @param hash
* The Hashtable to use
@@ -54,7 +107,7 @@ public class CreateInteractionChoiceSet extends RPCRequest { *
* @param interactionChoiceSetID
* an Integer value representing the Choice Set ID
- * <p>
+ *
* <b>Notes: </b>Min Value: 0; Max Value: 2000000000
*/
public void setInteractionChoiceSetID( Integer interactionChoiceSetID ) {
@@ -95,7 +148,7 @@ public class CreateInteractionChoiceSet extends RPCRequest { * @param choiceSet
* a List<Choice> representing the array of one or more
* elements
- * <p>
+ *
* <b>Notes: </b>Min Value: 1; Max Value: 100
*/
public void setChoiceSet( List<Choice> choiceSet ) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSetResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSetResponse.java index d5a417090..36adc2857 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSetResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSetResponse.java @@ -12,6 +12,9 @@ import com.smartdevicelink.proxy.RPCResponse; * @since SmartDeviceLink 1.0
*/
public class CreateInteractionChoiceSetResponse extends RPCResponse {
+ /**
+ * Constructs a new CreateInteractionChoiceSetResponse object
+ */
public CreateInteractionChoiceSetResponse() {
super(FunctionID.CREATE_INTERACTION_CHOICE_SET.toString());
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DIDResult.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DIDResult.java index 0420aac2c..84afe2a70 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DIDResult.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DIDResult.java @@ -4,12 +4,56 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.VehicleDataResultCode;
+/** Individual requested DID result and data.
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Mandatory</th>
+ * <th> Additional</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td>resultCode</td>
+ * <td>VehicleDataResultCode</td>
+ * <td>true</td>
+ * <td></td>
+ * <td>Individual DID result code </td>
+ * </tr>
+ * <tr>
+ * <td>didLocation</td>
+ * <td>Integer</td>
+ * <td>true</td>
+ * <td>minvalue = 0 maxvalue = 65535 </td>
+ * <td>The address of DID location from the ReadDID request.</td>
+ * </tr>
+ *
+ * <tr>
+ * <td>data</td>
+ * <td>String</td>
+ * <td>false</td>
+ * <td>maxlength = 5000 </td>
+ * <td>The DID data which is the hex byte string of however many bytes are stored at that location</td>
+ * </tr>
+ * </table>
+ * @since SmartDeviceLink 1.0
+ *
+ * @see VehicleDataResultCode
+ * @see ReadDID
+ */
public class DIDResult extends RPCStruct {
public static final String KEY_RESULT_CODE = "resultCode";
public static final String KEY_DATA = "data";
public static final String KEY_DID_LOCATION = "didLocation";
-
+ /** <p>Constructs a new DIDResult object indicated by the Hashtable
+ * parameter</p>
+ * @param hash
+ * The hash table to use
+ */
+
public DIDResult() {}
public DIDResult(Hashtable<String, Object> hash) {
super(hash);
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DTC.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DTC.java index e7128d65e..e8ff471d8 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DTC.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DTC.java @@ -6,7 +6,7 @@ import com.smartdevicelink.proxy.RPCStruct; /**
* String containing hexadecimal identifier as well as other common names.
- * <p><b>Parameter List
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteCommand.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteCommand.java index bf32d6996..635f85814 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteCommand.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteCommand.java @@ -6,14 +6,47 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCRequest;
/**
- * Removes a command from the Command Menu
- * <p>
- * <b>HMI Status Requirements:</b><br/>
- * HMILevel: FULL, LIMITED or BACKGROUND<br/>
- * AudioStreamingState: N/A<br/>
- * SystemContext: Should not be attempted when VRSESSION or MENU
- * </p>
+ * Removes a command from the Command Menu.
*
+ * <p><b>HMI Status Requirements:</b></p>
+ * <p>HMILevel: FULL, LIMITED or BACKGROUND</p>
+ * AudioStreamingState: N/A
+ * <p>SystemContext: Should not be attempted when VRSESSION or MENU</p>
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>cmdID</td>
+ * <td>Integer</td>
+ * <td>Unique ID that identifies the Command to be deleted from Command Menu</td>
+ * <td>Y</td>
+ * <td>Min Value: 0;Max Value: 2000000000</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * </table>
+ *
+ *<p><b> Response:</b></p>
+ *
+ * Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code,this means a command was removed from the Command Menu successfully.
+ *
+ *<p><b> Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p>REJECTED</p>
+ * <p> INVALID_ID</p>
+ * <p> IN_USER</p>
* @since SmartDeviceLink 1.0
* @see AddCommand
* @see AddSubMenu
@@ -31,7 +64,7 @@ public class DeleteCommand extends RPCRequest { /**
* Constructs a new DeleteCommand object indicated by the Hashtable
* parameter
- * <p>
+ *
*
* @param hash
* The Hashtable to use
@@ -54,8 +87,8 @@ public class DeleteCommand extends RPCRequest { *
* @param cmdID
* an Integer value representing Command ID
- * <p>
- * <b>Notes: </b>Min Value: 0; Max Value: 2000000000
+ *
+ * <p><b>Notes: </b>Min Value: 0; Max Value: 2000000000</p>
*/
public void setCmdID( Integer cmdID ) {
if (cmdID != null) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteCommandResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteCommandResponse.java index b6bcc9e7d..ad905b1e0 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteCommandResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteCommandResponse.java @@ -6,11 +6,14 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCResponse;
/**
- * Delete Command Response is sent, when DeleteCommand has been called
+ * Delete Command Response is sent, when DeleteCommand has been called.
*
* @since SmartDeviceLink 1.0
*/
public class DeleteCommandResponse extends RPCResponse {
+ /** Constructs a new DeleteCommandResponse object
+ *
+ */
public DeleteCommandResponse() {
super(FunctionID.DELETE_COMMAND.toString());
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteFile.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteFile.java index b2bc91a99..4d35c6fd3 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteFile.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteFile.java @@ -8,8 +8,37 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* Used to delete a file resident on the SDL module in the app's local cache.
* Not supported on first generation SDL vehicles
- * <p>
*
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>SmartDeviceLink 2.0</th>
+ * </tr>
+ * <tr>
+ * <td>SDLFileName</td>
+ * <td>String</td>
+ * <td> File reference name.</td>
+ * <td>Y</td>
+ * <td>maxlength:500</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * </table>
+ *
+ * <p><b>Response </b></p>
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p> SUCCESS</p>
+ * <p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
* @since SmartDeviceLink 2.0
* @see PutFile
* @see ListFiles
@@ -25,8 +54,8 @@ public class DeleteFile extends RPCRequest { }
/**
- * Constructs a new DeleteFile object indicated by the Hashtable parameter
- * <p>
+ * <p>Constructs a new DeleteFile object indicated by the Hashtable parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteFileResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteFileResponse.java index ad54b2a14..9916b95dc 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteFileResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteFileResponse.java @@ -12,6 +12,9 @@ import com.smartdevicelink.proxy.RPCResponse; */
public class DeleteFileResponse extends RPCResponse {
public static final String KEY_SPACE_AVAILABLE = "spaceAvailable";
+ /** Constructs a new DeleteFileResponse object
+ *
+ */
public DeleteFileResponse() {
super(FunctionID.DELETE_FILE.toString());
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java index 0d7d610d7..87f8cdbc3 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java @@ -10,12 +10,50 @@ import com.smartdevicelink.proxy.RPCRequest; * interactionChoiceSetID. If the specified interactionChoiceSetID is currently
* in use by an active <i> {@linkplain PerformInteraction}</i> this call to
* delete the Choice Set will fail returning an IN_USE resultCode
- * <p>
- * Function Group: Base
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b><br/>
- * </p>
*
+ * <p>Function Group: Base</p>
+ *
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b></p>
+ *
+ * <p>AudioStreamingState: Any</p>
+ *
+ * <p>SystemContext: MAIN, MENU, VR </p>
+ *
+ * <p><b>Parameter List</b></p>
+ *
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>interactionChoiceSetID</td>
+ * <td>Integer</td>
+ * <td> A unique ID that identifies the Choice Set (specified in a previous call to CreateInteractionChoiceSet)</td>
+ * <td>Y</td>
+ * <td>Min Value: 0 ; Max Value: 2000000000</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * </table>
+ *
+ * <p><b>Response </b></p>
+ *
+ * If a resultCode of "SUCCESS" is returned, the requested choice set has been created and can now be referenced by the application using the value of interactionChoiceSetID provided by the application.
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
+ * <p>INVALID_ID</p>
+
* @since SmartDeviceLink 1.0
* @see CreateInteractionChoiceSet
* @see PerformInteraction
@@ -30,9 +68,9 @@ public class DeleteInteractionChoiceSet extends RPCRequest { super(FunctionID.DELETE_INTERACTION_CHOICE_SET.toString());
}
/**
- * Constructs a new DeleteInteractionChoiceSet object indicated by the
- * Hashtable parameter
- * <p>
+ * <p>Constructs a new DeleteInteractionChoiceSet object indicated by the
+ * Hashtable parameter</p>
+ *
*
* @param hash
* The Hashtable to use
@@ -50,8 +88,7 @@ public class DeleteInteractionChoiceSet extends RPCRequest { /**
* Sets a unique ID that identifies the Choice Set
* @param interactionChoiceSetID a unique ID that identifies the Choice Set
- * <p>
- * <b>Notes: </b>Min Value: 0; Max Value: 2000000000
+ * <p><b>Notes: </b>Min Value: 0; Max Value: 2000000000 </p>
*/
public void setInteractionChoiceSetID( Integer interactionChoiceSetID ) {
if (interactionChoiceSetID != null) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java index bd7fc216b..aac605f51 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java @@ -6,13 +6,46 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCRequest;
/**
- * Deletes a submenu from the Command Menu
- * <p>
- * <b>Notes: </b>When an app deletes a submenu that has child commands, those
- * child commands are also deleted
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
+ * Deletes a submenu from the Command Menu.
+ *
+ * <p><b>Notes: </b>When an app deletes a submenu that has child commands, those
+ * child commands are also deleted</p>
+ *
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>menuID</td>
+ * <td>Integer</td>
+ * <td>Unique ID that identifies the SubMenu to be delete</td>
+ * <td>Y</td>
+ * <td>Min Value: 0; Max Value: 2000000000</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * </table>
+ *
+ *<p> <b>Response </b></p>
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ *<p>SUCCESS</p>
+ *<p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p> REJECTED</p>
+ * <p> INVALID_ID</p>
+ * <p> IN_USE </p>
*
* @since SmartDeviceLink 1.0
* @see AddCommand
@@ -28,7 +61,7 @@ public class DeleteSubMenu extends RPCRequest { super(FunctionID.DELETE_SUB_MENU.toString());
}
/**
- * Constructs a new DeleteSubMenu object indicated by the Hashtable parameter<p>
+ * Constructs a new DeleteSubMenu object indicated by the Hashtable parameter
* @param hash The Hashtable to use
*/
public DeleteSubMenu(Hashtable<String, Object> hash) {
@@ -44,8 +77,8 @@ public class DeleteSubMenu extends RPCRequest { /**
* Sets the MenuID that identifies the SubMenu to be delete
* @param menuID an Integer value representing menuID that identifies the SubMenu to be delete
- * <p>
- * <b>Notes: </b>Min Value: 0; Max Value: 2000000000
+ *
+ * <p><b>Notes: </b>Min Value: 0; Max Value: 2000000000</p>
*/
public void setMenuID( Integer menuID ) {
if (menuID != null) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteSubMenuResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteSubMenuResponse.java index c13e37131..3e2c36dd4 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteSubMenuResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteSubMenuResponse.java @@ -11,6 +11,9 @@ import com.smartdevicelink.proxy.RPCResponse; * @since SmartDeviceLink 1.0
*/
public class DeleteSubMenuResponse extends RPCResponse {
+ /**
+ * Constructs a new DeleteSubMenuResponse object
+ */
public DeleteSubMenuResponse() {
super(FunctionID.DELETE_SUB_MENU.toString());
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeviceInfo.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeviceInfo.java index e57af4159..b7d8ea5cf 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeviceInfo.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeviceInfo.java @@ -3,7 +3,73 @@ package com.smartdevicelink.proxy.rpc; import java.util.Hashtable;
import com.smartdevicelink.proxy.RPCStruct;
-
+/**
+ * Various information about connecting device.
+ *
+ *
+ *
+ * <p><b>Parameter List</b></p>
+ *
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>hardware</td>
+ * <td>String</td>
+ * <td>Device model</td>
+ * <td>N</td>
+ * <td>Max Length: 500</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>firmwareRev</td>
+ * <td>String</td>
+ * <td>Device firmware revision</td>
+ * <td>N</td>
+ * <td>Max Length: 500</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>os</td>
+ * <td>String</td>
+ * <td>Device OS version</td>
+ * <td>N</td>
+ * <td>Max Length: 500</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>osVersion</td>
+ * <td>String</td>
+ * <td>Device OS version</td>
+ * <td>N</td>
+ * <td>Max Length: 500</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>carrier</td>
+ * <td>String</td>
+ * <td>Device mobile carrier (if applicable)</td>
+ * <td>N</td>
+ * <td>Max Length: 500</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>maxNumberRFCOMMPorts</td>
+ * <td>Integer</td>
+ * <td>Omitted if connected not via BT.</td>
+ * <td>N</td>
+ * <td>Min Value: 0; Max Value: 100</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * </table>
+ *
+ */
public class DeviceInfo extends RPCStruct{
public static final String KEY_HARDWARE = "hardware";
public static final String KEY_FIRMWARE_REV = "firmwareRev";
@@ -11,7 +77,16 @@ public class DeviceInfo extends RPCStruct{ public static final String KEY_OS_VERSION = "osVersion";
public static final String KEY_CARRIER = "carrier";
public static final String KEY_MAX_NUMBER_RFCOMM_PORTS = "maxNumberRFCOMMPorts";
- public static final String DEVICE_OS = "Android";
+ public static final String DEVICE_OS = "Android";
+
+ /** Constructs a new DeviceInfo object indicated by the Hashtable
+ * parameter
+ * @param hash
+ *
+ * The hash table to use
+ *
+ *
+ */
public DeviceInfo() { }
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeviceStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeviceStatus.java index ca110a8b3..51d5304b4 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeviceStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeviceStatus.java @@ -8,7 +8,7 @@ import com.smartdevicelink.proxy.rpc.enums.PrimaryAudioSource; /**
* Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle.
- * <p><b>Parameter List
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -95,6 +95,11 @@ import com.smartdevicelink.proxy.rpc.enums.PrimaryAudioSource; * </tr>
* </table>
* @since SmartDeviceLink 2.0
+ *
+ * @see DeviceLevelStatus
+ * @see GetVehicleData
+ * @see OnVehicleData
+ *
*/
public class DeviceStatus extends RPCStruct {
public static final String KEY_VOICE_REC_ON = "voiceRecOn";
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java index e5b8e8c45..0a0d8f997 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java @@ -5,20 +5,81 @@ import java.util.List; import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCRequest;
+/** Non periodic vehicle diagnostic request.
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>targetID</td>
+ * <td>Integer</td>
+ * <td>Name of target ECU.</td>
+ * <td>Y</td>
+ * <td>Min Value: 0; Max Value: 65535</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>messageLength</td>
+ * <td>Integer</td>
+ * <td>Length of message (in bytes).</td>
+ * <td>Y</td>
+ * <td>Min Value: 0; Max Value:65535</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>messageData</td>
+ * <td>Integer</td>
+ * <td>Array of bytes comprising CAN message.</td>
+ * <td>Y</td>
+ * <td>Min Value: 0; Max Value:255; Min Size:1; Max Size:65535</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * </table>
+ * <p><b>HMI must:</b> </p>
+ *
+ * <p>1. Check the requested data using provided information of targetID (name of ECU),messageLength and messageData.</p>
+ * <p> 2. Respond with one of the appropriate result codes.And in case of SUCCESS return messageDataResult which is an array of bytes comprising CAN message result.</p>
+ * @since SmartDeviceLink 3.0
+ *
+ */
public class DiagnosticMessage extends RPCRequest {
public static final String KEY_TARGET_ID = "targetID";
public static final String KEY_MESSAGE_LENGTH = "messageLength";
public static final String KEY_MESSAGE_DATA = "messageData";
+ /**
+ * Constructs a new DiagnosticMessage object
+ */
public DiagnosticMessage() {
super(FunctionID.DIAGNOSTIC_MESSAGE.toString());
}
+ /**
+ * <p>
+ * Constructs a new DiagnosticMessage object indicated by the Hashtable
+ * parameter
+ * </p>
+ *
+ * @param hash
+ * The Hashtable to use
+ */
public DiagnosticMessage(Hashtable<String, Object> hash) {
super(hash);
}
+ /** Sets TargetID
+ *
+ * @param targetID
+ */
+
public void setTargetID(Integer targetID) {
if (targetID != null) {
parameters.put(KEY_TARGET_ID, targetID);
@@ -26,6 +87,14 @@ public class DiagnosticMessage extends RPCRequest { parameters.remove(KEY_TARGET_ID);
}
}
+ /**
+ * <p>
+ * Returns an <i>Integer</i> object representing the Target ID that you want to add
+ * </p>
+ *
+ * @return Integer -an integer representation a Unique Target ID
+ */
+
public Integer getTargetID() {
return (Integer) parameters.get(KEY_TARGET_ID);
}
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DiagnosticMessageResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DiagnosticMessageResponse.java index 57e5bc98b..8cb0bc8d4 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DiagnosticMessageResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DiagnosticMessageResponse.java @@ -5,9 +5,16 @@ import java.util.List; import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCResponse;
-
+/**
+ * Diagnostic Message Response is sent, when DiagnosticMessage has been called.
+ *
+ * @since SmartDeviceLink 3.0
+ */
public class DiagnosticMessageResponse extends RPCResponse {
public static final String KEY_MESSAGE_DATA_RESULT = "messageDataResult";
+ /**
+ * Constructs a new DiagnosticMessageResponse object
+ */
public DiagnosticMessageResponse() {
super(FunctionID.DIAGNOSTIC_MESSAGE.toString());
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DialNumber.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DialNumber.java index 76fbc02d1..4651e1f20 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DialNumber.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DialNumber.java @@ -28,7 +28,7 @@ public class DialNumber extends RPCRequest { * @param number * a phone number is a string, which can be up to 40 chars. * <p> - * <b>Notes: </b>Maxlength=40<p> + * <b>Notes: </b>Maxlength=40</p> * All characters shall be stripped from string except digits 0-9 and * # , ; + */ public void setNumber(String number) { diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java index 1a44ad601..f0739e371 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java @@ -10,7 +10,7 @@ import com.smartdevicelink.proxy.rpc.enums.MediaClockFormat; import com.smartdevicelink.util.DebugTool;
/**
* Contains information about the display for the SDL system to which the application is currently connected.
- * <p><b> Parameter List
+ * <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -47,6 +47,11 @@ import com.smartdevicelink.util.DebugTool; * </tr>
* </table>
* @since SmartDeviceLink 1.0
+ * @see DisplayType
+ * @see MediaClockFormat
+ * @see TextFieldName
+ * @see ImageType
+ *
*/
public class DisplayCapabilities extends RPCStruct {
public static final String KEY_DISPLAY_TYPE = "displayType";
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ECallInfo.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ECallInfo.java index 21173c487..88eb89e03 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ECallInfo.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ECallInfo.java @@ -5,12 +5,62 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.ECallConfirmationStatus;
import com.smartdevicelink.proxy.rpc.enums.VehicleDataNotificationStatus;
+/** Emergency Call notification and confirmation data.
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>eCallNotificationStatus</td>
+ * <td>VehicleDataNotificationStatus</td>
+ * <td>References signal "eCallNotification_4A".</td>
+ * <td></td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>auxECallNotificationStatus</td>
+ * <td>VehicleDataNotificationStatus</td>
+ * <td>References signal "eCallNotification". This is an alternative signal available on some carlines replacing the eCallNotificationStatus, but showing the same values.</td>
+ * <td></td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>eCallConfirmationStatus</td>
+ * <td>ECallConfirmationStatus</td>
+ * <td>References signal "eCallConfirmation"</td>
+ * <td></td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * </table>
+ * @since SmartDeviceLink 2.0
+ * @see SubscribeVehicleData
+ *
+ *
+ * @see TextFieldName
+ * @see Image
+ *
+ */
public class ECallInfo extends RPCStruct {
public static final String KEY_E_CALL_NOTIFICATION_STATUS = "eCallNotificationStatus";
public static final String KEY_AUX_E_CALL_NOTIFICATION_STATUS = "auxECallNotificationStatus";
public static final String KEY_E_CALL_CONFIRMATION_STATUS = "eCallConfirmationStatus";
-
+ /** Constructs a new ECallInfo object indicated by the Hashtable
+ * parameter
+ * @param hash
+ *
+ * <p>The hash table to use</p>
+ */
public ECallInfo() { }
public ECallInfo(Hashtable<String, Object> hash) {
super(hash);
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/EmergencyEvent.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/EmergencyEvent.java index 77fa72e5b..5e1f2ede1 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/EmergencyEvent.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/EmergencyEvent.java @@ -6,6 +6,67 @@ import com.smartdevicelink.proxy.RPCStruct; import com.smartdevicelink.proxy.rpc.enums.EmergencyEventType;
import com.smartdevicelink.proxy.rpc.enums.FuelCutoffStatus;
import com.smartdevicelink.proxy.rpc.enums.VehicleDataEventStatus;
+/** Information related to an emergency event (and if it occurred).
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Mandatory</th>
+ * <th>Description</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>emergencyEventType</td>
+ * <td>EmergencyEventType</td>
+ * <td></td>
+ * <td>References signal "VedsEvntType_D_Ltchd". See{@linkplain EmergencyEventType}</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelCutoffStatus</td>
+ * <td>FuelCutoffStatus</td>
+ * <td></td>
+ * <td>References signal "RCM_FuelCutoff". See{@linkplain FuelCutoffStatus}</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>rolloverEvent</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td></td>
+ * <td>References signal "VedsEvntRoll_D_Ltchd". See{@linkplain VehicleDataEventStatus}</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>maximumChangeVelocity</td>
+ * <td>Integer</td>
+ * <td></td>
+ * <td>References signal "VedsMaxDeltaV_D_Ltchd".</td>
+ * <td>minvalue=0; maxvalue=255;<p> Additional reserved values:</p> <p>0x00 No event; 0xFE Not supported; 0xFF Fault</p> </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ *
+ *
+ * <tr>
+ * <td>multipleEvents</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td></td>
+ * <td>References signal "VedsMultiEvnt_D_Ltchd". See{@linkplain VehicleDataEventStatus}</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * </table>
+ *
+ * @see Image
+ * @see SubscribeVehicleData
+ * @since SmartDeviceLink 2.0
+ *
+ */
public class EmergencyEvent extends RPCStruct {
public static final String KEY_EMERGENCY_EVENT_TYPE = "emergencyEventType";
@@ -13,6 +74,13 @@ public class EmergencyEvent extends RPCStruct { public static final String KEY_ROLLOVER_EVENT = "rolloverEvent";
public static final String KEY_MAXIMUM_CHANGE_VELOCITY = "maximumChangeVelocity";
public static final String KEY_MULTIPLE_EVENTS = "multipleEvents";
+
+ /** Constructs a new EmergencyEvent object indicated by the Hashtable
+ * parameter
+ * @param hash
+ *
+ * <p>The hash table to use</p>
+ */
public EmergencyEvent() { }
public EmergencyEvent(Hashtable<String, Object> hash) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/EndAudioPassThru.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/EndAudioPassThru.java index 8a6793691..ab61c548e 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/EndAudioPassThru.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/EndAudioPassThru.java @@ -7,11 +7,24 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* When this request is invoked, the audio capture stops
- * <p>
- * Function Group: AudioPassThru
- * <p>
+ *
+ * <p>Function Group: AudioPassThru</p>
+ *
* <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
+ *
+ * <p><b>Request</b></p>
+ *
+ * <p>No parameters.</p>
+ * <p><b>Response</b> </p>
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
+ * <p>DISALLOWED</p>
* @since SmartDeviceLink 2.0
* @see PerformAudioPassThru
*/
@@ -25,9 +38,9 @@ public class EndAudioPassThru extends RPCRequest { }
/**
- * Constructs a new EndAudioPassThru object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new EndAudioPassThru object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GPSData.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GPSData.java index e21f694c1..d76b11355 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GPSData.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GPSData.java @@ -8,7 +8,7 @@ import com.smartdevicelink.proxy.rpc.enums.Dimension; import com.smartdevicelink.util.SdlDataTypeConverter;
/**
* Describes the GPS data. Not all data will be available on all carlines.
- * <p><b>Parameter List
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -55,21 +55,21 @@ import com.smartdevicelink.util.SdlDataTypeConverter; * <tr>
* <td>utcHours</td>
* <td>Integer</td>
- * <td>Minvalue: 1<b>Maxvalue: 23
+ * <td>Minvalue: 0<b>Maxvalue: 23
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
* <td>utcMinutes</td>
* <td>Integer</td>
- * <td>Minvalue: 1<b>Maxvalue: 59
+ * <td>Minvalue: 0<b>Maxvalue: 59
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
* <td>utcSeconds</td>
* <td>Integer</td>
- * <td>Minvalue: 1<b>Maxvalue: 59
+ * <td>Minvalue: 0<b>Maxvalue: 59
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
@@ -115,9 +115,9 @@ import com.smartdevicelink.util.SdlDataTypeConverter; * <td>altitude</td>
* <td>Integer</td>
* <td>Altitude in meters
- * <b>Minvalue: -10000
- * <b>Maxvalue: 10000
- * </td>
+ * <b>Minvalue: -10000</b>
+ * <b>Maxvalue: 10000</b>
+ * <b>Note:</b> SYNC uses Mean Sea Level for calculating GPS. </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GenericResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GenericResponse.java index e231dd04d..4618fd857 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GenericResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GenericResponse.java @@ -9,7 +9,43 @@ import com.smartdevicelink.proxy.RPCResponse; * Generic Response is sent, when the name of a received msg cannot be
* retrieved. Only used in case of an error. Currently, only resultCode
* INVALID_DATA is used.
-*/
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>success</td>
+ * <td>Boolean</td>
+ * <td>true, if successful; false, if failed</td>
+ * <td></td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>resultCode</td>
+ * <td>Result</td>
+ * <td>Defines the possible result codes returned by SDL to the application in a Response to a requested operation</td>
+ * <td></td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>info</td>
+ * <td>String</td>
+ * <td>Provides additional human readable info regarding the result.</td>
+ * <td>N</td>
+ * <td>maxlength=1000</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * </table>
+ * @since SmartDeviceLink 1.0
+ */
public class GenericResponse extends RPCResponse {
public GenericResponse() {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetDTCs.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetDTCs.java index 967c62cbb..fa3ba1c01 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetDTCs.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetDTCs.java @@ -7,12 +7,52 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* This RPC allows to request diagnostic module trouble codes from a certain
- * vehicle module
- * <p>
- * Function Group: ProprietaryData
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * <p>
+ * vehicle module.
+ *
+ *<p> Function Group: ProprietaryData</p>
+ *
+ *<p> <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>ecuName</td>
+ * <td>Integer</td>
+ * <td>Name of ECU.</td>
+ * <td>Y</td>
+ * <td>Min Value: 0; Max Value: 65535</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>dtcMask</td>
+ * <td>Integer</td>
+ * <td>DTC Mask Byte to be sent in diagnostic request to module.</td>
+ * <td>N</td>
+ * <td>Min Value: 0; Max Value: 255</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * </table>
+ * <p><b>Response</b></p>
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ *<p> SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ *<p> OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ *<p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
+ * <p>DISALLOWED </p>
+ * <p>USER_DISALLOWED</p>
+ * @since SmartDeviceLink 2.0
*/
public class GetDTCs extends RPCRequest {
public static final String KEY_DTC_MASK = "dtcMask";
@@ -26,8 +66,8 @@ public class GetDTCs extends RPCRequest { }
/**
- * Constructs a new GetDTCs object indicated by the Hashtable parameter
- * <p>
+ * <p>Constructs a new GetDTCs object indicated by the Hashtable parameter
+ * </p>
*
* @param hash
* The Hashtable to use
@@ -43,7 +83,7 @@ public class GetDTCs extends RPCRequest { * an Integer value representing a name of the module to receive
* the DTC form
* <p>
- * <b>Notes: </b>Minvalue:0; Maxvalue:65535
+ * <b>Notes:</p> </b>Minvalue:0; Maxvalue:65535
*/
public void setEcuName(Integer ecuName) {
if (ecuName != null) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetVehicleData.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetVehicleData.java index b3d2e6189..0c15c02c9 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetVehicleData.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetVehicleData.java @@ -4,7 +4,202 @@ import java.util.Hashtable; import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCRequest;
-
+/**
+ * Non periodic vehicle data read request.
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>gps</td>
+ * <td>Boolean</td>
+ * <td>GPS data. See {@linkplain GPS data }for details</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>speed</td>
+ * <td>Boolean</td>
+ * <td>The vehicle speed in kilometers per hour</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>rpm</td>
+ * <td>Boolean</td>
+ * <td>The number of revolutions per minute of the engine</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel</td>
+ * <td>Boolean</td>
+ * <td>The fuel level in the tank (percentage)</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel_State</td>
+ * <td>Boolean</td>
+ * <td>The fuel level state</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>instantFuelConsumption</td>
+ * <td>Boolean</td>
+ * <td>The instantaneous fuel consumption in microlitres</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>externalTemperature</td>
+ * <td>Boolean</td>
+ * <td>The external temperature in degrees celsius</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>vin</td>
+ * <td>Boolean</td>
+ * <td>Vehicle identification number</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>prndl</td>
+ * <td>Boolean</td>
+ * <td>Currently selected gear.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>tirePressure</td>
+ * <td>Boolean</td>
+ * <td>Tire pressure status</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>odometer</td>
+ * <td>Boolean</td>
+ * <td>Odometer in km</td>
+ * <td>N</td>
+ * <td>Max Length: 500</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>beltStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the seat belts</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>bodyInformation</td>
+ * <td>Boolean</td>
+ * <td>The body information including ignition status and internal temp</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>deviceStatus</td>
+ * <td>Boolean</td>
+ * <td>The device status including signal and battery strength</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>driverBraking</td>
+ * <td>Boolean</td>
+ * <td>The status of the brake pedal</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>wiperStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the wipers</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>headLampStatus</td>
+ * <td>Boolean</td>
+ * <td>Status of the head lamps</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>engineTorque</td>
+ * <td>Boolean</td>
+ * <td>Torque value for engine (in Nm) on non-diesel variants</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>accPedalPosition</td>
+ * <td>Boolean</td>
+ * <td>Accelerator pedal position (percentage depressed)</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>steeringWheelAngle</td>
+ * <td>Boolean</td>
+ * <td>Current angle of the steering wheel (in deg)</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * </table>
+ *
+ *
+ * <p><b>Response</b></p>
+ *
+ * <p> <b>Non-default Result Codes:</b></p>
+ * <p> SUCCESS</p>
+ * <p> INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p> REJECTED</p>
+ * <p> VEHICLE_DATA_NOT_ALLOWED</p>
+ * <p>VEHICLE_DATA_NOT_AVAILABLE</p>
+ * <p> USER_DISALLOWED</p>
+ *
+ * @see SubscribeVehicleData
+ * @see UnSubscribeVehicleData
+ * @since SmartDeviceLink 2.0
+ *
+ *
+ */
public class GetVehicleData extends RPCRequest {
public static final String KEY_SPEED = "speed";
public static final String KEY_RPM = "rpm";
@@ -31,10 +226,23 @@ public class GetVehicleData extends RPCRequest { public static final String KEY_EMERGENCY_EVENT = "emergencyEvent";
public static final String KEY_CLUSTER_MODE_STATUS = "clusterModeStatus";
public static final String KEY_MY_KEY = "myKey";
+ /**
+ * Constructs a new GetVehicleData object
+ */
public GetVehicleData() {
super(FunctionID.GET_VEHICLE_DATA.toString());
}
+ /**
+ * <p>
+ * Constructs a new GetVehicleDta object indicated by the Hashtable
+ * parameter
+ * </p>
+ *
+ * @param hash
+ * The Hashtable to use
+ */
+
public GetVehicleData(Hashtable<String, Object> hash) {
super(hash);
}
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetVehicleDataResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetVehicleDataResponse.java index 3ae2b54d8..51eb7a4b7 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetVehicleDataResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetVehicleDataResponse.java @@ -12,6 +12,11 @@ import com.smartdevicelink.proxy.rpc.enums.WiperStatus; import com.smartdevicelink.util.DebugTool;
import com.smartdevicelink.util.SdlDataTypeConverter;
+/**
+ * Get Vehicle Data Response is sent, when GetVehicleData has been called.
+ *
+ * @since SmartDeviceLink 2.0
+ */
public class GetVehicleDataResponse extends RPCResponse {
public static final String KEY_SPEED = "speed";
public static final String KEY_RPM = "rpm";
@@ -39,6 +44,9 @@ public class GetVehicleDataResponse extends RPCResponse { public static final String KEY_CLUSTER_MODE_STATUS = "clusterModeStatus";
public static final String KEY_MY_KEY = "myKey";
+ /**
+ * Constructs a new GetVehicleDataResponse object
+ */
public GetVehicleDataResponse() {
super(FunctionID.GET_VEHICLE_DATA.toString());
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/HMIPermissions.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/HMIPermissions.java index 629fb7b79..d8223279a 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/HMIPermissions.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/HMIPermissions.java @@ -8,7 +8,7 @@ import com.smartdevicelink.proxy.RPCStruct; import com.smartdevicelink.proxy.rpc.enums.HMILevel;
/**
* Defining sets of HMI levels, which are permitted or prohibited for a given RPC.
- * <p><b>Parameter List
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -30,7 +30,7 @@ import com.smartdevicelink.proxy.rpc.enums.HMILevel; * <tr>
* <td>userDisallowed</td>
* <td>HMILevel</td>
- * <td>A set of all HMI levels that are prohibated for this given RPC.
+ * <td>A set of all HMI levels that are prohibited for this given RPC.
* <ul>
* <li>Min: 0</li>
* <li>Max: 100</li>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/HeadLampStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/HeadLampStatus.java index 70f3fd76f..46a982fe2 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/HeadLampStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/HeadLampStatus.java @@ -4,11 +4,51 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.AmbientLightStatus;
+/** Status of the head lamps.
+ *
+ * <p><table border="1" rules="all"></p>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Mandatory</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td>lowBeamsOn</td>
+ * <td>Boolean</td>
+ * <td>true</td>
+ * <td>Status of the low beam lamps. </td>
+ * </tr>
+ * <tr>
+ * <td>highBeamsOn</td>
+ * <td>Boolean</td>
+ * <td>true</td>
+ * <td>Status of the high beam lamps. </td>
+ * </tr>
+ * <tr>
+ * <td>ambientLightSensorStatus</td>
+ * <td>AmbientLightStatus</td>
+ * <td>true</td>
+ * <td>Status of the ambient light sensor.</td>
+ * </tr>
+ *
+ *
+ * </table>
+ * @see OnVehicleData
+ * @see GetVehicleData
+ * @since SmartDeviceLink 1.0
+ *
+ */
public class HeadLampStatus extends RPCStruct {
public static final String KEY_AMBIENT_LIGHT_SENSOR_STATUS = "ambientLightSensorStatus";
public static final String KEY_HIGH_BEAMS_ON = "highBeamsOn";
public static final String KEY_LOW_BEAMS_ON = "lowBeamsOn";
+ /**<p> Constructs a new HeadLampStatus object indicated by the Hashtable
+ * parameter</p>
+ * @param hash
+ * The hash table to use
+ */
public HeadLampStatus() {}
public HeadLampStatus(Hashtable<String, Object> hash) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Headers.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Headers.java index 0e72ff6e3..2be4f1a17 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Headers.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Headers.java @@ -3,6 +3,11 @@ package com.smartdevicelink.proxy.rpc; import java.util.Hashtable;
import com.smartdevicelink.proxy.RPCStruct;
+/**
+ *
+ * @since SmartDeviceLink 3.0
+ *
+ */
public class Headers extends RPCStruct {
public static final String KEY_CONTENT_TYPE = "ContentType";
@@ -17,7 +22,16 @@ public class Headers extends RPCStruct { public static final String KEY_CONTENT_LENGTH = "Content-Length";
public Headers() { }
-
+ /**
+ * <p>
+ * Constructs a new Headers object indicated by the Hashtable
+ * parameter
+ * </p>
+ *
+ * @param hash
+ * The Hashtable to use
+ */
+
public Headers(Hashtable<String, Object> hash) {
super(hash);
}
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Image.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Image.java index d46607923..76ad2d224 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Image.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Image.java @@ -7,7 +7,7 @@ import com.smartdevicelink.proxy.rpc.enums.ImageType; /**
*Specifies, which image shall be used, e.g. in Alerts or on Softbuttons provided the display supports it.
- *<p><b>Parameter List
+ *<p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ImageField.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ImageField.java index 528b23425..9e38dc264 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ImageField.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ImageField.java @@ -8,6 +8,53 @@ import com.smartdevicelink.proxy.RPCStruct; import com.smartdevicelink.proxy.rpc.enums.FileType;
import com.smartdevicelink.proxy.rpc.enums.ImageFieldName;
import com.smartdevicelink.util.DebugTool;
+/** <p>The name that identifies the field.For example AppIcon,SoftButton, LocationImage, etc.</p>
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th> Version</th>
+ * </tr>
+ * <tr>
+ * <td>name</td>
+ * <td>ImageFieldName</td>
+ * <td>The name that identifies the field.{@linkplain ImageFieldName}</td>
+ * <td></td>
+ * <td></td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>imageTypeSupported</td>
+ * <td>FileType</td>
+ * <td>The image types that are supported in this field. {@linkplain FileType}</td>
+ * <td></td>
+ * <td>maxlength: 100</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>imageResolution</td>
+ * <td>ImageResolution</td>
+ * <td>The image resolution of this field.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * </table>
+ * @since SmartDeviceLink 3.0
+ * @see DisplayType
+ * @see MediaClockFormat
+ * @see TextFieldName
+ * @see ImageType
+ *
+ *
+ *
+ *
+ */
public class ImageField extends RPCStruct {
public static final String KEY_IMAGE_TYPE_SUPPORTED = "imageTypeSupported";
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ImageResolution.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ImageResolution.java index 4242a09f1..682092082 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ImageResolution.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ImageResolution.java @@ -3,13 +3,60 @@ package com.smartdevicelink.proxy.rpc; import com.smartdevicelink.proxy.RPCStruct;
import java.util.Hashtable;
+/** The image resolution of this field.
+ *
+ * <p><b>Parameter List</b></p>
+ *
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>resolutionWidth</td>
+ * <td>Integer</td>
+ * <td>The image resolution width.</td>
+ * <td></td>
+ * <td>minvalue:1; maxvalue: 10000</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>resolutionHeight</td>
+ * <td>Integer</td>
+ * <td>The image resolution height.</td>
+ * <td></td>
+ * <td>minvalue:1; maxvalue: 10000</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ *
+ * </table>
+ * @since SmartDeviceLink 3.0
+ * @see DisplayType
+ * @see MediaClockFormat
+ * @see TextFieldName
+ * @see ImageType
+ *
+ */
public class ImageResolution extends RPCStruct {
public static final String KEY_RESOLUTION_WIDTH = "resolutionWidth";
public static final String KEY_RESOLUTION_HEIGHT = "resolutionHeight";
public ImageResolution() {}
-
+ /**
+ * <p>
+ * Constructs a new ImageResolution object indicated by the Hashtable
+ * parameter
+ * </p>
+ *
+ * @param hash
+ * The Hashtable to use
+ */
+
public ImageResolution(Hashtable<String, Object> hash) {
super(hash);
}
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/KeyboardProperties.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/KeyboardProperties.java index 4e5652581..fb35dcf24 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/KeyboardProperties.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/KeyboardProperties.java @@ -7,6 +7,66 @@ import com.smartdevicelink.proxy.RPCStruct; import com.smartdevicelink.proxy.rpc.enums.KeyboardLayout;
import com.smartdevicelink.proxy.rpc.enums.KeypressMode;
import com.smartdevicelink.proxy.rpc.enums.Language;
+/** This mode causes the interaction to immediately display a keyboard entry through the HMI.
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Mandatory</th>
+ * <th> Additional</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td>language</td>
+ * <td>Language</td>
+ * <td>false</td>
+ * <td></td>
+ * <td>The keyboard language. </td>
+ * </tr>
+ * <tr>
+ * <td>keyboardLayout</td>
+ * <td>KeyboardLayout</td>
+ * <td>false</td>
+ * <td></td>
+ * <td>Desired keyboard layout.</td>
+ * </tr>
+ * <tr>
+ * <td>sendDynamicEntry</td>
+ * <td>Boolean</td>
+ * <td>false</td>
+ * <td></td>
+ * <td>In this mode, all keypresses will be sent as they occur. If disabled, entire string of text will be returned only once submitted by user.If omitted, this value will be set to FALSE.</td>
+ * </tr>
+ * <tr>
+ * <td>keypressMode</td>
+ * <td>KeypressMode</td>
+ * <td>False</td>
+ * <td></td>
+ * <td>Desired keypress mode.If omitted, this value will be set to RESEND_CURRENT_ENTRY. </td>
+ * </tr>
+ * <tr>
+ * <td>limitedCharacterList</td>
+ * <td>String</td>
+ * <td>false</td>
+ * <td>Array = true maxlength = 1 minsize = 1 maxsize = 100</td>
+ * <td>Array of keyboard characters to enable. All omitted characters will be greyed out (disabled) on the keyboard. If omitted, the entire keyboard will be enabled.</td>
+ * </tr>
+ *
+ * <tr>
+ * <td>autoCompleteText</td>
+ * <td>String</td>
+ * <td>false</td>
+ * <td>maxlength = 1000 </td>
+ * <td>Allows an app to prepopulate the text field with a suggested or completed entry as the user types.</td>
+ * </tr>
+ * </table>
+ *
+ * @since SmartDeviceLink 3.0
+ *@see ButtonName
+ *
+ */
public class KeyboardProperties extends RPCStruct {
public static final String KEY_KEYPRESS_MODE = "keypressMode";
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ListFiles.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ListFiles.java index f135eaa9e..faeaa7977 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ListFiles.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ListFiles.java @@ -7,9 +7,20 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* Requests the current list of resident filenames for the registered app. Not
- * supported on First generation SDL vehicles
- * <p>
+ * supported on First generation SDL vehicles.
*
+ * <p><b>Request</b></p>
+ * <p>No parameters.</p>
+ * <p><b>Response:</b></p>
+ * Returns the current list of resident filenames for the registered app along with the current space available.
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR </p>
+ * <p>REJECTED</p>
* @since SmartDeviceLink 2.0
*/
public class ListFiles extends RPCRequest {
@@ -22,8 +33,8 @@ public class ListFiles extends RPCRequest { }
/**
- * Constructs a new ListFiles object indicated by the Hashtable parameter
- * <p>
+ * <p>Constructs a new ListFiles object indicated by the Hashtable parameter
+ * </p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/MenuParams.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/MenuParams.java index 065a8f1ac..a9f22238a 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/MenuParams.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/MenuParams.java @@ -5,7 +5,7 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
/**
* Used when adding a sub menu to an application menu or existing sub menu.
- * <p><b> Parameter List
+ * <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -15,7 +15,7 @@ import com.smartdevicelink.proxy.RPCStruct; * </tr>
* <tr>
* <td>parentID</td>
- * <td>Int32</td>
+ * <td>Integer</td>
* <td>The unique ID of an existing submenu to which a command will be added.
* If this element is not provided, the command will be added to the top level of the Command Menu.
* <ul>
@@ -25,9 +25,9 @@ import com.smartdevicelink.proxy.RPCStruct; * </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
- * <tr>
+ * <tr>
* <td>position</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>Position within the items of the parent Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc.
* Position of any submenu will always be located before the return and exit options.
* <ul>
@@ -52,6 +52,8 @@ import com.smartdevicelink.proxy.RPCStruct; * </tr>
* </table>
* @since SmartDeviceLink 1.0
+ * @see AddCommand
+ * @see AddSubMenu
*/
public class MenuParams extends RPCStruct {
public static final String KEY_PARENT_ID = "parentID";
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/MyKey.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/MyKey.java index 96d05dcec..4936f9fec 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/MyKey.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/MyKey.java @@ -4,9 +4,43 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.VehicleDataStatus;
+/** Information related to the MyKey feature.
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Mandatory</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td>e911Override</td>
+ * <td>VehicleDataStatus</td>
+ * <td>true</td>
+ * <td>Indicates whether e911 override is on.</td>
+ * </tr>
+ * </table>
+ *
+ *@since SmartDeviceLink 2.0
+ *
+ *@see GetVehicleData
+ *@see OnVehicleData
+ *@see VehicleDataStatus
+ *
+ *
+ */
public class MyKey extends RPCStruct {
public static final String KEY_E_911_OVERRIDE = "e911Override";
+ /**
+ * <p>
+ * Constructs a new MyKey object indicated by the Hashtable
+ * parameter
+ * </p>
+ *
+ * @param hash
+ * The Hashtable to use
+ */
public MyKey() { }
public MyKey(Hashtable<String, Object> hash) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnAppInterfaceUnregistered.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnAppInterfaceUnregistered.java index 21cb9bc52..af155226e 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnAppInterfaceUnregistered.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnAppInterfaceUnregistered.java @@ -20,7 +20,7 @@ import com.smartdevicelink.proxy.rpc.enums.AppInterfaceUnregisteredReason; * SystemContext:
* <ul><li>Any</li></ul>
* </ul>
- * <p>
+ * <p></p>
* <b>Parameter List:</b>
* <table border="1" rules="all">
* <tr>
@@ -36,7 +36,6 @@ import com.smartdevicelink.proxy.rpc.enums.AppInterfaceUnregisteredReason; * <td>SmartDeviceLink 1.0</td>
* </tr>
* </table>
- * </p>
* @since SmartDeviceLink 1.0
* @see RegisterAppInterface
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnAudioPassThru.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnAudioPassThru.java index 421bbd933..40186c63d 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnAudioPassThru.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnAudioPassThru.java @@ -35,7 +35,6 @@ import com.smartdevicelink.proxy.RPCNotification; * <th>Notes</th>
* <th>SmartDeviceLink Ver Available</th>
* </tr>
-
* </table>
* </p>
*
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnButtonEvent.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnButtonEvent.java index 3e5bf33f4..7f9afb627 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnButtonEvent.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnButtonEvent.java @@ -9,7 +9,7 @@ import com.smartdevicelink.proxy.rpc.enums.ButtonName; /**
* Notifies application that user has depressed or released a button to which
- * the application has subscribed.</br> Further information about button events
+ * the application has subscribed.Further information about button events
* and button-presses can be found at {@linkplain SubscribeButton}.
* <p>
* </p>
@@ -36,7 +36,7 @@ import com.smartdevicelink.proxy.rpc.enums.ButtonName; * button will cancel VR.</li>
* </ul>
* </ul>
- * <p>
+ * <p></p>
* <b>Parameter List:</b>
* <table border="1" rules="all">
* <tr>
@@ -66,14 +66,14 @@ import com.smartdevicelink.proxy.rpc.enums.ButtonName; * <tr>
* <td>customButtonID</td>
* <td>Integer</td>
- * <td>If ButtonName is ��CUSTOM_BUTTON", this references the integer ID passed
+ * <td>If ButtonName is CUSTOM_BUTTON", this references the integer ID passed
* by a custom button. (e.g. softButton ID)</td>
* <td>N</td>
* <td>Minvalue=0 Maxvalue=65536</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* </table>
- * </p>
+ * <p></p>
*
* @since SmartDeviceLink 1.0
*
@@ -142,7 +142,7 @@ public class OnButtonEvent extends RPCNotification { return null;
}
/**
- * <p> Set the event mode of the button,pressed or released
+ * <p> Set the event mode of the button,pressed or released</p>
* @param buttonEventMode indicates the button is pressed or released
* @see ButtonEventMode
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnButtonPress.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnButtonPress.java index 2d48b9635..c881cc297 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnButtonPress.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnButtonPress.java @@ -74,7 +74,7 @@ import com.smartdevicelink.proxy.rpc.enums.ButtonPressMode; * <tr>
* <td>customButtonID</td>
* <td>Integer</td>
- * <td>If ButtonName is ��CUSTOM_BUTTON", this references the integer ID passed
+ * <td>If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed
* by a custom button. (e.g. softButton ID)</td>
* <td>N</td>
* <td>Minvalue=0 Maxvalue=65536</td>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnCommand.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnCommand.java index 77632b8b2..eae7e77f8 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnCommand.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnCommand.java @@ -32,7 +32,7 @@ import com.smartdevicelink.proxy.rpc.enums.TriggerSource; * </tr>
* <tr>
* <td>cmdID</td>
- * <td>Int32</td>
+ * <td>Integer</td>
* <td>The cmdID of the command the user selected. This is the cmdID value provided by the application in the AddCommand operation that created the command.</td>
* <td></td>
* <td>SmartDeviceLink 1.0</td>
@@ -99,8 +99,8 @@ public class OnCommand extends RPCNotification { return null;
}
/**
- * <p>Sets TriggerSource<br/>
- * Indicates whether command was selected via VR or via a menu selection (using the OK button).</p>
+ * <p>Sets TriggerSource</p>
+ * <p>Indicates whether command was selected via VR or via a menu selection (using the OK button).</p>
* @param triggerSource a TriggerSource object
*/
public void setTriggerSource( TriggerSource triggerSource ) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnHashChange.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnHashChange.java index e806e5225..776d69e4a 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnHashChange.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnHashChange.java @@ -4,13 +4,50 @@ import java.util.Hashtable; import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCNotification;
-
+/**
+ * Notification containing an updated hashID which can be used over connection cycles (i.e. loss of connection, ignition cycles, etc.).
+ * Sent after initial registration and subsequently after any change in the calculated hash of all persisted app data.
+ * <p></p>
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>hashID</td>
+ * <td>String</td>
+ * <td>Calculated hash ID to be referenced during RegisterAppInterface.</td>
+ * <td>Y</td>
+ * <td>maxlength: 100</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * </table>
+ * @since SmartDeviceLink 3.0
+ *
+ */
public class OnHashChange extends RPCNotification {
public static final String KEY_HASH_ID = "hashID";
+ /**
+ * Constructs a new OnHashChange object
+ */
public OnHashChange() {
super(FunctionID.ON_HASH_CHANGE.toString());
}
+ /**
+ * <p>
+ * Constructs a new OnKeyboardInput object indicated by the Hashtable
+ * parameter
+ * </p>
+ *
+ * @param hash
+ * The Hashtable to use
+ */
public OnHashChange(Hashtable<String, Object> hash) {
super(hash);
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java index 4de2acf3f..e71cda0a8 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java @@ -6,14 +6,59 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCNotification;
import com.smartdevicelink.proxy.rpc.enums.KeyboardEvent;
+/**
+ * On-screen keyboard event. Can be full string or individual keypresses depending on keyboard mode.
+ * <p></p>
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>event</td>
+ * <td>KeyboardEvent</td>
+ * <td>On-screen keyboard input data.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 3.0</td>
+ * </tr>
+ * <tr>
+ * <td>data</td>
+ * <td>String</td>
+ * <td>On-screen keyboard input data.For dynamic keypress events, this will be the current compounded string of entry text.For entry cancelled and entry aborted events, this data param will be omitted.</td>
+ * <td></td>
+ * <td>Maxlength: 500</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ *
+ * </table>
+ *
+ */
public class OnKeyboardInput extends RPCNotification {
public static final String KEY_DATA = "data";
public static final String KEY_EVENT = "event";
+ /**
+ * Constructs a new OnKeyboardInput object
+ */
public OnKeyboardInput() {
super(FunctionID.ON_KEYBOARD_INPUT.toString());
}
+ /**
+ * <p>
+ * Constructs a new OnKeyboardInput object indicated by the Hashtable
+ * parameter
+ * </p>
+ *
+ * @param hash
+ * The Hashtable to use
+ */
public OnKeyboardInput(Hashtable<String, Object> hash) {
super(hash);
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnLockScreenStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnLockScreenStatus.java index 1ad23994c..11f6469ef 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnLockScreenStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnLockScreenStatus.java @@ -4,7 +4,15 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCNotification;
import com.smartdevicelink.proxy.rpc.enums.HMILevel;
import com.smartdevicelink.proxy.rpc.enums.LockScreenStatus;
-
+import com.smartdevicelink.proxy.rpc.OnHMIStatus;
+/**
+ * The lockscreen must perform the following:
+ * Limit all application control usability from the mobile device with a full-screen static image overlay or separate view.
+ * For simplicity, the OnLockScreenStatus RPC will be provided via the onOnLockScreenNotification call back. The call back will include the LockScreenStatus enum which indicates if the lockscreen is required, optional or not required.
+ * The call back also includes details regarding the current HMI_Status level, driver distraction status and user selection status of the application.
+ *
+ *
+ */
public class OnLockScreenStatus extends RPCNotification {
public static final String KEY_DRIVER_DISTRACTION = "driverDistraction";
public static final String KEY_SHOW_LOCK_SCREEN = "showLockScreen";
@@ -13,7 +21,11 @@ public class OnLockScreenStatus extends RPCNotification { public OnLockScreenStatus() {
super(FunctionID.ON_LOCK_SCREEN_STATUS.toString());
}
-
+ /**
+ * <p>Get the current driver distraction status(i.e. whether driver distraction rules are in effect, or not)</p>
+ * @return Boolean
+ */
+
public Boolean getDriverDistractionStatus() {
return (Boolean)parameters.get(KEY_DRIVER_DISTRACTION);
}
@@ -26,7 +38,11 @@ public class OnLockScreenStatus extends RPCNotification { parameters.remove(KEY_DRIVER_DISTRACTION);
}
}
-
+ /**
+ * <p>Get the {@linkplain LockScreenStatus} enumeration, indicating if the lockscreen should be required, optional or off </p>
+ * @return {@linkplain LockScreenStatus}
+ */
+
public LockScreenStatus getShowLockScreen() {
return (LockScreenStatus)parameters.get(KEY_SHOW_LOCK_SCREEN);
}
@@ -38,7 +54,11 @@ public class OnLockScreenStatus extends RPCNotification { parameters.remove(KEY_SHOW_LOCK_SCREEN);
}
}
-
+ /**
+ * <p>Get user selection status for the application (has the app been selected via hmi or voice command)</p>
+ * @return Boolean the current user selection status
+ */
+
public Boolean getUserSelected() {
return (Boolean)parameters.get(KEY_USER_SELECTED);
}
@@ -50,7 +70,11 @@ public class OnLockScreenStatus extends RPCNotification { parameters.remove(KEY_USER_SELECTED);
}
}
-
+ /**
+ * <p>Get HMILevel in effect for the application</p>
+ * @return {@linkplain HMILevel} the current HMI Level in effect for the application
+ */
+
public HMILevel getHMILevel() {
return (HMILevel)parameters.get(OnHMIStatus.KEY_HMI_LEVEL);
}
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnSystemRequest.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnSystemRequest.java index a48f32a05..a034626a9 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnSystemRequest.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnSystemRequest.java @@ -14,7 +14,70 @@ import com.smartdevicelink.proxy.RPCNotification; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.FileType;
import com.smartdevicelink.proxy.rpc.enums.RequestType;
-
+/**
+ * An asynchronous request from the system for specific data from the device or the cloud or response to a request from the device or cloud. Binary data can be included in hybrid part of message for some requests (such as Authentication request responses)
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>requestType</td>
+ * <td>RequestType</td>
+ * <td>The type of system request.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.3.2 </td>
+ * </tr>
+ * <tr>
+ * <td>url</td>
+ * <td>Array of Strings</td>
+ * <td>Optional URL for HTTP requests.If blank, the binary data shall be forwarded to the app.If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds.</td>
+ * <td>N</td>
+ * <td>maxlength: 1000; minsize:1; maxsize: 100</td>
+ * <td>SmartDeviceLink 2.3.2 </td>
+ * </tr>
+ * <tr>
+ * <td>timeout</td>
+ * <td>Integer</td>
+ * <td>Optional timeout for HTTP requests;Required if a URL is provided</td>
+ * <td>N</td>
+ * <td>minvalue:0; maxvalue: 2000000000</td>
+ * <td>SmartDeviceLink </td>
+ * </tr>
+ * <tr>
+ * <td>fileType</td>
+ * <td>FileType</td>
+ * <td>Optional file type (meant for HTTP file requests).</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.3.2 </td>
+ * </tr>
+ * <tr>
+ * <td>offset</td>
+ * <td>Float</td>
+ * <td>Optional offset in bytes for resuming partial data chunks</td>
+ * <td>N</td>
+ * <td>minvalue:0; maxvalue:100000000000</td>
+ * <td>SmartDeviceLink 2.3.2 </td>
+ * </tr>
+ * <tr>
+ * <td>length</td>
+ * <td>Float</td>
+ * <td>Optional length in bytes for resuming partial data chunks</td>
+ * <td>N</td>
+ * <td>minvalue: 0; maxvalue:100000000000</td>
+ * <td>SmartDeviceLink 2.3.2 </td>
+ * </tr>
+ * </table>
+ * @since SmartDeviceLink 2.3.2
+ */
public class OnSystemRequest extends RPCNotification {
public static final String KEY_URL_V1 = "URL";
public static final String KEY_URL = "url";
@@ -29,8 +92,12 @@ public class OnSystemRequest extends RPCNotification { public static final String KEY_LENGTH = "length";
private String body;
- private Headers headers;
+ private Headers headers;
+ /** Constructs a new OnSystemsRequest object
+ *
+ */
+
public OnSystemRequest() {
super(FunctionID.ON_SYSTEM_REQUEST.toString());
}
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnTouchEvent.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnTouchEvent.java index 47ecc30a3..bfb31d789 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnTouchEvent.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnTouchEvent.java @@ -8,13 +8,62 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCNotification;
import com.smartdevicelink.proxy.rpc.enums.TouchType;
+/**
+ *
+ * Notifies about touch events on the screen's prescribed area.
+ * <p><b>Parameter List</b></p>
+ *
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>type</td>
+ * <td>TouchType</td>
+ * <td>The type of touch event.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>event</td>
+ * <td>TouchEvent</td>
+ * <td>List of all individual touches involved in this event.</td>
+ * <td>Y</td>
+ * <td>minsize:1; maxsize:10</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * </table>
+ *
+ * <p><b>Note:</b></p>
+ * <p>SDL needs to be informed about every User`s touching the touch screen.</p>
+ *
+ */
public class OnTouchEvent extends RPCNotification {
public static final String KEY_EVENT = "event";
public static final String KEY_TYPE = "type";
-
+ /**
+ * Constructs a new OnTouchEvent object
+ */
+
public OnTouchEvent() {
super(FunctionID.ON_TOUCH_EVENT.toString());
}
+ /**
+ * <p>
+ * Constructs a new OnTouchEvent object indicated by the Hashtable
+ * parameter
+ * </p>
+ *
+ * @param hash
+ * The Hashtable to use
+ */
+
public OnTouchEvent(Hashtable<String, Object> hash) {
super(hash);
}
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnVehicleData.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnVehicleData.java index ec50e659e..1a6baefef 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnVehicleData.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnVehicleData.java @@ -10,7 +10,239 @@ import com.smartdevicelink.proxy.rpc.enums.VehicleDataEventStatus; import com.smartdevicelink.proxy.rpc.enums.WiperStatus;
import com.smartdevicelink.util.DebugTool;
import com.smartdevicelink.util.SdlDataTypeConverter;
-
+/**
+ *Individual requested DID result and data.
+ *
+ *
+ * <p>Callback for the periodic and non periodic vehicle data read function.</p>
+ *
+ * <p> <b>Note:</b></p>
+ *
+ * Initially SDL sends SubscribeVehicleData for getting the periodic updates from HMI whenever each of subscribed data types changes. OnVehicleData is expected to bring such updated values to SDL
+ *
+ *
+ *
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>Gps</td>
+ * <td>Boolean</td>
+ * <td>GPS data. See {@linkplain GPSdata} for details</td>
+ * <td>N</td>
+ * <td>Subscribable </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>Speed</td>
+ * <td>Float</td>
+ * <td>The vehicle speed in kilometers per hour</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>rpm</td>
+ * <td>Integer</td>
+ * <td>The number of revolutions per minute of the engine</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel</td>
+ * <td>Float</td>
+ * <td>The fuel level in the tank (percentage)</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel_State</td>
+ * <td>ComponentVolumeStatus</td>
+ * <td>The fuel level state (Ok/Low)</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>instantFuelConsumption</td>
+ * <td>Float</td>
+ * <td>The instantaneous fuel consumption in microlitres</td>
+ * <td>N</td>
+ * <td>Subscribable </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>externalTemperature</td>
+ * <td>Float</td>
+ * <td>The external temperature in degrees celsius.</td>
+ * <td>N</td>
+ * <td>Subscribable </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>vin</td>
+ * <td>String</td>
+ * <td>Vehicle identification number.</td>
+ * <td>N</td>
+ * <td>Subscribable </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>prndl</td>
+ * <td>PRNDL</td>
+ * <td>Currently selected gear.</td>
+ * <td>N</td>
+ * <td>Subscribable </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>tirePressure</td>
+ * <td>TireStatus</td>
+ * <td>Tire pressure status</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>odometer</td>
+ * <td>Integer</td>
+ * <td>Odometer in km</td>
+ * <td>N</td>
+ * <td>Subscribable </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>beltStatus</td>
+ * <td>BeltStatus</td>
+ * <td>The status of the seat belts.</td>
+ * <td>N</td>
+ * <td>Subscribable </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>bodyInformation</td>
+ * <td>BodyInformation</td>
+ * <td>The body information including power modes.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>deviceStatus</td>
+ * <td>DeviceStatus</td>
+ * <td>The connected mobile device status including signal and battery strength.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>eCallInfo</td>
+ * <td>ECallInfo</td>
+ * <td>Emergency Call notification and confirmation data.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>airbagStatus</td>
+ * <td>AirBagStatus</td>
+ * <td>The status of the air bags.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>emergencyEvent</td>
+ * <td>EmergencyEvernt</td>
+ * <td>Information related to an emergency event (and if it occurred).</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>clusterModeStatus</td>
+ * <td>ClusterModeStatus</td>
+ * <td>The status modes of the instrument panel cluster.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>myKey</td>
+ * <td>MyKey</td>
+ * <td>Information related to the MyKey feature.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ *
+ * <tr>
+ * <td>driverBraking</td>
+ * <td>vehicleDataEventStatus</td>
+ * <td>The status of the brake pedal.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>wiperStatus</td>
+ * <td>WiperStatus</td>
+ * <td>The status of the wipers</td>
+ * <td>N</td>
+ * <td> </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>headLampStatus</td>
+ * <td>headLampStatus</td>
+ * <td>Status of the head lamps</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>engineTorque</td>
+ * <td>Float</td>
+ * <td>Torque value for engine (in Nm) on non-diesel variants</td>
+ * <td>N</td>
+ * <td>minvalue:-1000; maxvalue:2000</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>accPedalPosition</td>
+ * <td>Float</td>
+ * <td>Accelerator pedal position (percentage depressed)</td>
+ * <td>N</td>
+ * <td>minvalue: 0; maxvalue:100</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>steeringWheelAngle</td>
+ * <td>Float</td>
+ * <td>Current angle of the steering wheel (in deg)</td>
+ * <td>N</td>
+ * <td> minvalue: -2000; maxvalue:2000</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * </table>
+ *
+ * @since SmartDeviceLink 1.0
+ *
+ * @see SubscribeVehicleData
+ * @see UnsubscribeVehicleData
+ *
+ *
+ */
public class OnVehicleData extends RPCNotification {
public static final String KEY_SPEED = "speed";
public static final String KEY_RPM = "rpm";
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ParameterPermissions.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ParameterPermissions.java index ef8eddc16..996de27ac 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ParameterPermissions.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ParameterPermissions.java @@ -7,7 +7,7 @@ import com.smartdevicelink.proxy.RPCStruct; /**
* Defining sets of parameters, which are permitted or prohibited for a given RPC.
- * <p><b>Parameter List
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java index 4ba1658b2..0e663f63d 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java @@ -12,13 +12,84 @@ import com.smartdevicelink.proxy.rpc.enums.SamplingRate; /**
* This will open an audio pass thru session. By doing so the app can receive
- * audio data through the vehicle�s microphone
- * <p>
- * Function Group: AudioPassThru
- * <p>
+ * audio data through the vehicles microphone
+ *
+ * <p>Function Group: AudioPassThru</p>
+ *
* <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
*
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th> Version</th>
+ * </tr>
+ * <tr>
+ * <td>initialPrompt</td>
+ * <td>TTSChunk[]</td>
+ * <td>SDL will speak this prompt before opening the audio pass thru session. </td>
+ * <td>N</td>
+ * <td>This is an array of text chunks of type TTSChunk. The array must have at least one item If omitted, then no initial prompt is spoken: <p>Array Minsize: 1</p> Array Maxsize: 100</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>audioPassThruDisplayText1</td>
+ * <td>String</td>
+ * <td>First line of text displayed during audio capture.</td>
+ * <td>N</td>
+ * <td>Maxlength = 500</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>samplingRate</td>
+ * <td>SamplingRate</td>
+ * <td>This value shall is allowed to be 8 or 16 or 22 or 44 khz.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>maxDuration</td>
+ * <td>Integer</td>
+ * <td>The maximum duration of audio recording in milliseconds.</td>
+ * <td>Y</td>
+ * <td>Minvalue: 1; Maxvalue: 1000000</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>bitsPerSample</td>
+ * <td>BitsPerSample</td>
+ * <td>Specifies the quality the audio is recorded - 8 bit or 16 bit.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>audioType</td>
+ * <td>AudioType</td>
+ * <td>Specifies the type of audio data being requested.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>muteAudio</td>
+ * <td>Boolean</td>
+ * <td>N</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ *
+ *
+ *
+ *
+ *
+ * </table>
* @since SmartDeviceLink 2.0
* @see EndAudioPassThru
*/
@@ -40,9 +111,9 @@ public class PerformAudioPassThru extends RPCRequest { }
/**
- * Constructs a new PerformAudioPassThru object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new PerformAudioPassThru object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
@@ -59,7 +130,7 @@ public class PerformAudioPassThru extends RPCRequest { * a List<TTSChunk> value represents the initial prompt which
* will be spoken before opening the audio pass thru session by
* SDL
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>This is an array of text chunks of type TTSChunk</li>
@@ -109,9 +180,9 @@ public class PerformAudioPassThru extends RPCRequest { * Sets a line of text displayed during audio capture
*
* @param audioPassThruDisplayText1
- * a String value representing the line of text displayed during
- * audio capture
- * <p>
+ * <p>a String value representing the line of text displayed during
+ * audio capture</p>
+ * <p></p>
* <b>Notes: </b>Maxlength=500
*/
public void setAudioPassThruDisplayText1(String audioPassThruDisplayText1) {
@@ -136,9 +207,9 @@ public class PerformAudioPassThru extends RPCRequest { * Sets a line of text displayed during audio capture
*
* @param audioPassThruDisplayText2
- * a String value representing the line of text displayed during
- * audio capture
- * <p>
+ * <p>a String value representing the line of text displayed during
+ * audio capture</p>
+ * <p></p>
* <b>Notes: </b>Maxlength=500
*/
public void setAudioPassThruDisplayText2(String audioPassThruDisplayText2) {
@@ -194,7 +265,7 @@ public class PerformAudioPassThru extends RPCRequest { * @param maxDuration
* an Integer value representing the maximum duration of audio
* recording in millisecond
- * <p>
+ * <p></p>
* <b>Notes: </b>Minvalue:1; Maxvalue:1000000
*/
public void setMaxDuration(Integer maxDuration) {
@@ -274,8 +345,8 @@ public class PerformAudioPassThru extends RPCRequest { }
/**
- * Gets a Boolean value representing if the current audio source should be
- * muted during the APT session<br/>
+ *<p> Gets a Boolean value representing if the current audio source should be
+ * muted during the APT session</p>
*
*
* @return Boolean -a Boolean value representing if the current audio source
@@ -286,11 +357,11 @@ public class PerformAudioPassThru extends RPCRequest { }
/**
- * Sets a muteAudio value representing if the current audio source should be
- * muted during the APT session<br/>
+ * <p>Sets a muteAudio value representing if the current audio source should be
+ * muted during the APT session
* If not, the audio source will play without interruption. If omitted, the
- * value is set to true
- * <p>
+ * value is set to true</p>
+ *
*
* @param muteAudio
* a Boolean value representing if the current audio source
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformAudioPassThruResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformAudioPassThruResponse.java index 7ba905f96..2e90356ed 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformAudioPassThruResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformAudioPassThruResponse.java @@ -20,9 +20,9 @@ public class PerformAudioPassThruResponse extends RPCResponse { }
/**
- * Constructs a new PerformAudioPassThruResponse object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new PerformAudioPassThruResponse object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformInteraction.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformInteraction.java index 3c6ed46a5..9ad8c1034 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformInteraction.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformInteraction.java @@ -14,11 +14,95 @@ import com.smartdevicelink.proxy.rpc.enums.LayoutMode; * application may use a PerformInteraction to ask a user to say the name of a
* song to play. The user's response is only valid if it appears in the
* specified Choice Sets and is recognized by SDL
- * <p>
- * Function Group: Base
- * <p>
- * <b>HMILevel needs to be FULL</b>
- * </p>
+ * <p></p>
+ * <p>Function Group: Base</p>
+ *
+ * <p><b>HMILevel needs to be FULL</b></p>
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>initialText</td>
+ * <td>String</td>
+ * <td>Displayed when the interaction begins. This text may be overlaid by the "Listening" prompt during the interaction. Text is displayed on first line of multiline display, and is centered. If text does not fit on line, it will be truncated</td>
+ * <td>Y</td>
+ * <td>maxlength:500</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>initialPrompt</td>
+ * <td>TTSChunk</td>
+ * <td>An array of one or more TTSChunks that, taken together, specify what is to be spoken to the user at the start of an interaction.</td>
+ * <td>Y</td>
+ * <td>minsize:1; maxsize:100</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>interactionMode</td>
+ * <td>InteractionMode</td>
+ * <td>Indicates how user selects interaction choice. User can choose either by voice (VR_ONLY), by visual selection from the menu (MANUAL_ONLY), or by either mode (BOTH). </td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>interactionChoiceSetIDList</td>
+ * <td>Integer</td>
+ * <td>Array of one or more Choice Set IDs. User can select any choice from any of the specified Choice Sets.</td>
+ * <td>Y</td>
+ * <td>minsize:0; maxsize:100; minvalue:0; maxvalue:2000000000</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>helpPrompt</td>
+ * <td>TTSChunk</td>
+ * <td>An array of TTSChunks which, taken together, specify the help phrase to be spoken when the user says "help" during the VR session. If this parameter is omitted, the help prompt will be constructed by SDL from the first vrCommand of each choice of all the Choice Sets specified in the interactionChoiceSetIDList parameter. </td>
+ * <td>N</td>
+ * <td>minsize:1; maxsize:100; The helpPrompt specified in SetGlobalProperties is not used by PerformInteraction.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>timeoutPrompt</td>
+ * <td>TTSChunk</td>
+ * <td>An array of TTSChunks which, taken together, specify the phrase to be spoken when the listen times out during the VR session. If this parameter is omitted, the timeout prompt will be the same as the help prompt (see helpPrompt parameter). </td>
+ * <td>N</td>
+ * <td>The timeoutPrompt specified in SetGlobalProperties is not used by PerformInteraction. minsize:1;maxsize:100</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>timeout</td>
+ * <td>Integer</td>
+ * <td>The amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu). If this time elapses without the user making a choice, the timeoutPrompt will be spoken. After this timeout value has been reached, the interaction will stop and a subsequent interaction will take place after SDL speaks the timeout prompt. If that times out as well, the interaction will end completely. If omitted, the default is 10000ms.</td>
+ * <td>N</td>
+ * <td>minvalue:5000; maxvalue:100000; defvalue:10000</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>vrHelp</td>
+ * <td>VrHelpItem</td>
+ * <td>Ability to send suggested VR Help Items to display on-screen during Perform Interaction If omitted on supported displays, the default SDL generated list of suggested choices will be displayed.</td>
+ * <td>N</td>
+ * <td>Min = 1;Max = 100</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>interactionLayout</td>
+ * <td>LayoutMode</td>
+ * <td>See {@linkplain LayoutMode}</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 3.0</td>
+ * </tr>
+ * </table>
+ *
*
* @since SmartDeviceLink 1.0
* @see CreateInteractionChoiceSet
@@ -43,7 +127,7 @@ public class PerformInteraction extends RPCRequest { /**
* Constructs a new PerformInteraction object indicated by the Hashtable
* parameter
- * <p>
+ *
*
* @param hash
* The Hashtable to use
@@ -181,7 +265,7 @@ public class PerformInteraction extends RPCRequest { * -a List<Integer> representing an Array of one or more Choice
* Set IDs. User can select any choice from any of the specified
* Choice Sets
- * <p>
+ * <p></p>
* <b>Notes: </b>Min Value: 0; Max Vlaue: 2000000000
*/
public void setInteractionChoiceSetIDList(List<Integer> interactionChoiceSetIDList) {
@@ -221,11 +305,11 @@ public class PerformInteraction extends RPCRequest { /**
* Sets An array of TTSChunks which, taken together, specify the help phrase
* to be spoken when the user says "help" during the VR session
- * <p>
+ * <p></p>
* If this parameter is omitted, the help prompt will be constructed by SDL
* from the first vrCommand of each choice of all the Choice Sets specified
* in the interactionChoiceSetIDList parameter
- * <P>
+ * <P></p>
* <b>Notes: </b>The helpPrompt specified in
* {@linkplain SetGlobalProperties} is not used by PerformInteraction
*
@@ -270,7 +354,7 @@ public class PerformInteraction extends RPCRequest { /**
* Sets An array of TTSChunks which, taken together, specify the phrase to
* be spoken when the listen times out during the VR session
- * <p>
+ * <p></p>
* <b>Notes: </b>The timeoutPrompt specified in
* {@linkplain SetGlobalProperties} is not used by PerformInteraction
*
@@ -309,7 +393,7 @@ public class PerformInteraction extends RPCRequest { * an Integer value representing the amount of time, in
* milliseconds, SDL will wait for the user to make a choice (VR
* or Menu)
- * <p>
+ * <p></p>
* <b>Notes: </b>Min Value: 5000; Max Value: 100000
*/
public void setTimeout(Integer timeout) {
@@ -352,10 +436,10 @@ public class PerformInteraction extends RPCRequest { *
* @param vrHelp
* a List representing a suggested VR Help Items to display
- * on-screen during Perform Interaction<br/>
+ * on-screen during Perform Interaction
* If omitted on supported displays, the default SDL generated
* list of suggested choices will be displayed
- * <p>
+ * <p></p>
* <b>Notes: </b>Min=1; Max=100
* @since SmartDeviceLink 2.0
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformInteractionResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformInteractionResponse.java index c0c212a85..c2b56dcd0 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformInteractionResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformInteractionResponse.java @@ -26,7 +26,7 @@ public class PerformInteractionResponse extends RPCResponse { /**
* Constructs a new PerformInteractionResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -66,7 +66,7 @@ public class PerformInteractionResponse extends RPCResponse { return null;
}
/**
- * <p>Sets TriggerSource<br/>
+ * <p>Sets TriggerSource
* Indicates whether command was selected via VR or via a menu selection (using the OK button).</p>
* @param triggerSource a TriggerSource object
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PermissionItem.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PermissionItem.java index 42165fa87..7776c12b7 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PermissionItem.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PermissionItem.java @@ -1,14 +1,65 @@ package com.smartdevicelink.proxy.rpc;
+
import java.util.Hashtable;
import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.util.DebugTool;
-
+/**
+ * Change in permissions for a given set of RPCs
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>rpcName</td>
+ * <td>String</td>
+ * <td>Name of the individual RPC in the policy table.</td>
+ * <td></td>
+ * <td>maxlength:100</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>hmiPermissions</td>
+ * <td>HMIPermissions</td>
+ * <td>Sets of parameters, which are permitted or prohibited for the given RPC.</td>
+ * <td></td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ *
+ * <tr>
+ * <td>parameterPermissions</td>
+ * <td>ParameterPermissions</td>
+ * <td>Sets of parameters, which are permitted or prohibited for the given RPC.</td>
+ * <td></td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * </table>
+ *
+ * @since SmartDeviceLink 2.0
+ */
public class PermissionItem extends RPCStruct {
public static final String KEY_RPC_NAME = "rpcName";
public static final String KEY_HMI_PERMISSIONS = "hmiPermissions";
public static final String KEY_PARAMETER_PERMISSIONS = "parameterPermissions";
+ /**
+ * <p>
+ * Constructs a new PermissionItem object indicated by the Hashtable
+ * parameter
+ * </p>
+ *
+ * @param hash
+ * The Hashtable to use
+ */
public PermissionItem() { }
public PermissionItem(Hashtable<String, Object> hash) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java index 06adf2b12..df28213c7 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java @@ -6,7 +6,7 @@ import com.smartdevicelink.proxy.RPCStruct; /**
* Contains information about on-screen preset capabilities.
- * <p><b>Parameter List
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PutFile.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PutFile.java index e47c95bda..065ad14d5 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PutFile.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PutFile.java @@ -10,9 +10,102 @@ import com.smartdevicelink.proxy.rpc.listeners.OnRPCResponseListener; /**
* Used to push a binary data onto the SDL module from a mobile device, such as
- * icons and album art
- * <p>
+ * icons and album art.
*
+ * <p><b> Parameter List</b></p>
+ *
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>FileName</td>
+ * <td>String</td>
+ * <td>File reference name.</td>
+ * <td>Y</td>
+ * <td>Maxlength=500</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>fileType</td>
+ * <td>FileType</td>
+ * <td>Selected file type.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>persistentFile</td>
+ * <td>Boolean</td>
+ * <td>Indicates if the file is meant to persist between sessions / ignition cycles. If set to TRUE,then the system will aim to persist this file through session / cycles. While files with this designation will have priority over others,they are subject to deletion by the system at any time.In the event of automatic deletion by the system, the app will receive a rejection and have to resend the file. If omitted, the value will be set to false.</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>systemFile</td>
+ * <td>Boolean</td>
+ * <td>Indicates if the file is meant to be passed thru core to elsewhere on the system. If set to TRUE, then the system will instead pass the data thru as it arrives to a predetermined area outside of core. If omitted, the value will be set to false.</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
+ * <tr>
+ * <td>offset</td>
+ * <td>Float</td>
+ * <td>Optional offset in bytes for resuming partial data chunks</td>
+ * <td>N</td>
+ * <td>Minvalue=0; Maxvalue=100000000000</td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
+ * <tr>
+ * <td>length</td>
+ * <td>Float</td>
+ * <td>Optional length in bytes for resuming partial data chunks. If offset is set to 0, then length is the total length of the file to be downloaded</td>
+ * <td>N</td>
+ * <td>Minvalue=0; Maxvalue=100000000000</td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
+ * </table>
+ * <p> <b>Note: </b></p>
+ * When using PutFiles you may want to check for memory
+ *
+ * <p><b>Response</b> </p>
+ * Response is sent, when the file data was copied (success case). Or when an error occurred. Not supported on First generation SDL modules.
+ *
+ * <p><b> Non-default Result Codes:</b></p>
+ * <p> SUCCESS</p>
+ * <p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p>REJECTED</p>
+ *
+ * <p><table border="1" rules="all"></p>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>spaceAvailable</td>
+ * <td>Integer</td>
+ * <td>Provides the total local space available on SDL for the registered app.</td>
+ * <td></td>
+ * <td>Minvalue=0; Maxvalue=2000000000</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ *
+ * </table>
* @since SmartDeviceLink 2.0
* @see DeleteFile
* @see ListFiles
@@ -35,7 +128,7 @@ public class PutFile extends RPCRequest { /**
* Constructs a new PutFile object indicated by the Hashtable parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -49,7 +142,7 @@ public class PutFile extends RPCRequest { *
* @param sdlFileName
* a String value representing a file reference name
- * <p>
+ * <p></p>
* <b>Notes: </b>Maxlength=500
*/
public void setSdlFileName(String sdlFileName) {
@@ -106,7 +199,7 @@ public class PutFile extends RPCRequest { * by the system at any time. In the event of automatic deletion by the
* system, the app will receive a rejection and have to resend the file. If
* omitted, the value will be set to false
- * <p>
+ * <p></p>
*
* @param persistentFile
* a Boolean value
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PutFileResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PutFileResponse.java index 88c0560b3..b9195981b 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PutFileResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PutFileResponse.java @@ -23,7 +23,7 @@ public class PutFileResponse extends RPCResponse { /**
* Constructs a new PutFileResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ReadDID.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ReadDID.java index f165ae050..285416881 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ReadDID.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ReadDID.java @@ -7,14 +7,63 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCRequest;
/**
- * Non periodic vehicle data read request. This is an RPC to get diagnostics
+ * <p>Non periodic vehicle data read request. This is an RPC to get diagnostics
* data from certain vehicle modules. DIDs of a certain module might differ from
- * vehicle type to vehicle type
- * <p>
- * Function Group: ProprietaryData
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * <p>
+ * vehicle type to vehicle type</p>
+ *
+ * <p>Function Group: ProprietaryData</p>
+ *
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>ecuName</td>
+ * <td>Integer</td>
+ * <td>Name of ECU.</td>
+ * <td>Y</td>
+ * <td>Minvalue: 0; Maxvalue: 65535</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ *
+ * <tr>
+ * <td>didLocation</td>
+ * <td>Integer</td>
+ * <td>Get raw data from vehicle data DID location(s).</td>
+ * <td>Y</td>
+ * <td>Minvalue: 0; Maxvalue: 65535</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <td>appID</td>
+ * <td>Integer</td>
+ * <td>ID of the application that requested this RPC.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * </table>
+ *
+ * <p><b>Response</b></p>
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
+ * <p> DISALLOWED</p>
+ * <p>USER_DISALLOWED </p>
+ * <p>TRUNCATED_DATA</p>
*
* @since SmartDeviceLink 2.0
*/
@@ -31,7 +80,7 @@ public class ReadDID extends RPCRequest { /**
* Constructs a new ReadDID object indicated by the Hashtable parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -45,7 +94,7 @@ public class ReadDID extends RPCRequest { *
* @param ecuName
* an Integer value representing the ID of the vehicle module
- * <p>
+ * <p></p>
* <b>Notes: </b>Minvalue:0; Maxvalue:65535
*/
public void setEcuName(Integer ecuName) {
@@ -72,7 +121,7 @@ public class ReadDID extends RPCRequest { * @param didLocation
* a List<Integer> value representing raw data from vehicle
* data DID location(s)
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>Minvalue:0; Maxvalue:65535</li>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java index 8af901be3..99bcba01a 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java @@ -18,14 +18,14 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * sending an <i> {@linkplain OnAppInterfaceUnregistered}</i> notification, or
* by loss of the underlying transport connection, or closing of the underlying
* message transmission protocol RPC session
- * <p>
+ * <p></p>
* Until the application receives its first <i>{@linkplain OnHMIStatus}</i>
* Notification, its HMI Status is assumed to be: <i>
* {@linkplain com.smartdevicelink.proxy.rpc.enums.HMILevel}</i>=NONE, <i>
* {@linkplain com.smartdevicelink.proxy.rpc.enums.AudioStreamingState}
* </i>=NOT_AUDIBLE, <i>
* {@linkplain com.smartdevicelink.proxy.rpc.enums.SystemContext}</i>=MAIN
- * <p>
+ * <p></p>
* 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®
@@ -36,9 +36,9 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * 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
- * <p>
+ * <p></p>
* Resources and settings whose lifespan is tied to the duration of an
- * application's interface registration:<br/>
+ * application's interface registration:
* <ul>
* <li>Choice Sets</li>
* <li>Command Menus (built by successive calls to <i>{@linkplain AddCommand}
@@ -47,13 +47,13 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * <li>Media clock timer display value</li>
* <li>Media clock timer display value</li>
* </ul>
- * <p>
+ * <p></p>
* The autoActivateID is used to grant an application the HMILevel and
* AudioStreamingState it had when it last disconnected
- * <p>
+ * <p></p>
* <b>Notes: </b>The autoActivateID parameter, and associated behavior, is
* currently ignored by SDL®
- * <p>
+ * <p></p>
* 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
@@ -62,19 +62,154 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * turned off while the application is running, the autoActivateID can then be
* passed in another call to RegisterAppInterface to re-acquire <i>
* {@linkplain com.smartdevicelink.proxy.rpc.enums.HMILevel}</i>=FULL
- * <p>
+ * <p></p>
* 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®
- * <p>
+ * <p></p>
* There is no time limit for how long the autoActivateID is "valid" (i.e. would
* confer focus and opt-in)
- * <p>
- * <b>HMILevel is not defined before registering</b><br/>
- * </p>
*
+ *<p> <b>HMILevel is not defined before registering</b></p>
+ *
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>MsgVersion</td>
+ * <td>MsgVersion</td>
+ * <td>Declares what version of the SDL interface the application expects to use with SDL</td>
+ * <td>Y</td>
+ * <td>To be compatible, app msg major version number must be less than or equal to SDL major version number. <p>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).</p>However, the minor version number sent from the app to SDL (in RegisterAppInterface request) is ignored by SDL.</td>
+ * <td>SmartDeviceLink 1.0 </td>
+ * </tr>
+ * <tr>
+ * <td>appName</td>
+ * <td>String</td>
+ * <td>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 .</td>
+ * <td>Y</td>
+ * <td><p> Must be 1-100 characters in length. Must consist of following characters: </p><p>May not be the same (by case insensitive comparison) as the name or any synonym of any currently registered application.</p> </td>
+ * <td>SmartDeviceLink 1.0 </td>
+ * </tr>
+ * <tr>
+ * <td>ttsName</td>
+ * <td>TTSChunk</td>
+ * <td>TTS string for VR recognition of the mobile application name. Meant to overcome any failing on speech engine in properly pronouncing / understanding app name.</td>
+ * <td>N</td>
+ * <td><p>Size must be 1-100 Needs to be unique over all applications. May not be empty.<p>May not start with a new line character.</p></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>ngnMediaScreenAppName</td>
+ * <td>String</td>
+ * <td>Provides an abbreviated version of the app name (if necessary) that will be displayed on the NGN media screen.</td>
+ * <td>N</td>
+ * <td>- Must be 1-5 characters. If not provided, value will be derived from appName truncated to 5 characters.</td>
+ * <td>SmartDeviceLink 1.0 </td>
+ * </tr>
+ * <tr>
+ * <td>vrSynonyms</td>
+ * <td>String</td>
+ * <td>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.</td>
+ * <td>N</td>
+ * <td>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.</td>
+ * <td>SmartDeviceLink 1.0 </td>
+ * </tr>
+ * <tr>
+ * <td>isMediaApplication</td>
+ * <td>Boolean</td>
+ * <td>Indicates that the application will be streaming audio to SDL (via A2DP) that is audible outside of the BT media source.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0 </td>
+ * </tr>
+ * <tr>
+ * <td>languageDesired</td>
+ * <td>Language</td>
+ * <td>An enumeration indicating what language the application intends to use for user interaction (Display, TTS and VR).</td>
+ * <td>Y</td>
+ * <td>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. </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>hmiDisplayLanguageDesired</td>
+ * <td>Language</td>
+ * <td>An enumeration indicating what language the application intends to use for user interaction ( Display).</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>appHMIType</td>
+ * <td>AppHMIType</td>
+ * <td>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</td>
+ * <td>N</td>
+ * <td>Array Minsize: 1; Array Maxsize: 100</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>hashID</td>
+ * <td>String</td>
+ * <td>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.). </td>
+ * <td>N</td>
+ * <td>maxlength:100</td>
+ * <td>SmartDeviceLink 2.3.1 </td>
+ * </tr>
+ * <tr>
+ * <td>deviceInfo</td>
+ * <td>DeviceInfo</td>
+ * <td>Various information abount connecting device.</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.3.1 </td>
+ * </tr>
+ * <tr>
+ * <td>appID</td>
+ * <td>String</td>
+ * <td>ID used to validate app with policy table entries</td>
+ * <td>Y</td>
+ * <td>Maxlength: 100</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ *
+ * <tr>
+ * <td>hmiCapabilities</td>
+ * <td>HMICapabilities</td>
+ * <td>Specifies the HMI capabilities.</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.3.2.2 </td>
+ * </tr>
+ *
+ * <tr>
+ * <td>sdlVersion</td>
+ * <td>String</td>
+ * <td>The SmartDeviceLink version.</td>
+ * <td>N</td>
+ * <td>Maxlength: 100</td>
+ * <td>SmartDeviceLink 2.3.2.2</td>
+ * </tr>
+ *
+ * <tr>
+ * <td>systemSoftwareVersion</td>
+ * <td>String</td>
+ * <td>The software version of the system that implements the SmartDeviceLink core.</td>
+ * <td>N</td>
+ * <td>Maxlength: 100</td>
+ * <td>SmartDeviceLink 2.3.2.2</td>
+ * </tr>
+ * </table>
+ * <p></p>
* @since SmartDeviceLink 1.0
* @see UnregisterAppInterface
* @see OnAppInterfaceUnregistered
@@ -101,7 +236,7 @@ public class RegisterAppInterface extends RPCRequest { /**
* Constructs a new RegisterAppInterface object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -131,7 +266,7 @@ public class RegisterAppInterface extends RPCRequest { * @param sdlMsgVersion
* a SdlMsgVersion object representing version of the SDL®
* SmartDeviceLink interface
- * <p>
+ * <p></p>
* <b>Notes: </b>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
@@ -185,7 +320,7 @@ public class RegisterAppInterface extends RPCRequest { *
* @param appName
* a String value representing the Mobile Application's Name
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>Must be 1-100 characters in length</li>
@@ -232,8 +367,8 @@ public class RegisterAppInterface extends RPCRequest { *
* @param ttsName
* a List<TTSChunk> value represeting the TTS Name
- * <p>
- * <b>Notes: </b><br/>
+ * <p></p>
+ * <b>Notes: </b>
* <ul>
* <li>Size must be 1-100</li>
* <li>Needs to be unique over all applications</li>
@@ -272,7 +407,7 @@ public class RegisterAppInterface extends RPCRequest { * @param ngnMediaScreenAppName
* a String value representing an abbreviated version of the
* mobile applincation's name
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>Must be 1-5 characters</li>
@@ -315,7 +450,7 @@ public class RegisterAppInterface extends RPCRequest { * @param vrSynonyms
* a List<String> value representing the an array of 1-100
* elements
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>Each vr synonym is limited to 40 characters, and there can
@@ -376,7 +511,7 @@ public class RegisterAppInterface extends RPCRequest { *
* @param languageDesired
* a Language Enumeration
- * <p>
+ *
*
*/
public void setLanguageDesired(Language languageDesired) {
@@ -462,7 +597,7 @@ public class RegisterAppInterface extends RPCRequest { *
* @param appHMIType
* a List<AppHMIType>
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>Array Minsize: = 1</li>
@@ -507,7 +642,7 @@ public class RegisterAppInterface extends RPCRequest { * @param appID
* a String value representing a unique ID, which an app will be
* given when approved
- * <p>
+ * <p></p>
* <b>Notes: </b>Maxlength = 100
* @since SmartDeviceLink 2.0
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/RegisterAppInterfaceResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/RegisterAppInterfaceResponse.java index 05a96160c..f89e1a8b8 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/RegisterAppInterfaceResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/RegisterAppInterfaceResponse.java @@ -80,7 +80,7 @@ public class RegisterAppInterfaceResponse extends RPCResponse { * @param sdlMsgVersion
* a SdlMsgVersion object representing version of the SDL®
* SmartDeviceLink interface
- * <p>
+ * <p></p>
* <b>Notes: </b>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
@@ -123,7 +123,7 @@ public class RegisterAppInterfaceResponse extends RPCResponse { *
* @param language
* a Language Enumeration
- * <p>
+ *
*
*/
public void setLanguage(Language language) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java index 1121ce2c8..4a9f18d7f 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java @@ -10,16 +10,50 @@ import com.smartdevicelink.proxy.rpc.enums.GlobalProperty; /**
* Resets the passed global properties to their default values as defined by
* SDL
- * <p>
+ * <p></p>
* The HELPPROMPT global property default value is generated by SDL consists of
* the first vrCommand of each Command Menu item defined at the moment PTT is
- * pressed<br/>
- * The TIMEOUTPROMPT global property default value is the same as the HELPPROMPT
- * global property default value
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
+ * pressed
+ * <p>The TIMEOUTPROMPT global property default value is the same as the HELPPROMPT
+ * global property default value</p>
*
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>properties</td>
+ * <td>GlobalProperty</td>
+ * <td>An array of one or more GlobalProperty enumeration elements indicating which global properties to reset to their default value.</td>
+ * <td>Y</td>
+ * <td>Array must have at least one element.; minsize:1; maxsize:100</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ *
+ * </table>
+ * <p><b>Response</b></p>
+ *
+ * <p>Indicates whether the Global Properties were successfully set to their default values.</p>
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ *
+ * <p> SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR </p>
+ * <p> REJECTED </p>
+ * <p>DISALLOWED </p>
* @since SmartDeviceLink 1.0
* @see SetGlobalProperties
*/
@@ -34,7 +68,7 @@ public class ResetGlobalProperties extends RPCRequest { /**
* Constructs a new ResetGlobalProperties object indicated by the Hashtable
* parameter
- * <p>
+ *
*
* @param hash
* The Hashtable to use
@@ -80,7 +114,7 @@ public class ResetGlobalProperties extends RPCRequest { * a List<GlobalProperty> An array of one or more
* GlobalProperty enumeration elements indicating which global
* properties to reset to their default value
- * <p>
+ * <p></p>
* <b>Notes: </b>Array must have at least one element
*/
public void setProperties( List<GlobalProperty> properties ) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ResetGlobalPropertiesResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ResetGlobalPropertiesResponse.java index 3390fb814..dec7cde94 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ResetGlobalPropertiesResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ResetGlobalPropertiesResponse.java @@ -22,7 +22,7 @@ public class ResetGlobalPropertiesResponse extends RPCResponse { /**
* Constructs a new ResetGlobalPropertiesResponse object indicated by the Hashtable
* parameter
- * <p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScreenParams.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScreenParams.java index 9e32b9ffc..fe2c626a0 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScreenParams.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScreenParams.java @@ -6,13 +6,58 @@ import com.smartdevicelink.proxy.RPCStruct; import com.smartdevicelink.proxy.rpc.ImageResolution;
import com.smartdevicelink.proxy.rpc.TouchEventCapabilities;
import com.smartdevicelink.util.DebugTool;
+/** The resolution of the prescribed screen area.
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>resolution</td>
+ * <td>ImageResolution</td>
+ * <td>The resolution of the prescribed screen area.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
+ * <tr>
+ * <td>touchEventAvailable</td>
+ * <td>TouchEventCapabilities</td>
+ * <td>Types of screen touch events available in screen area.</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
+ *
+ * </table>
+ * @since SmartDeviceLink 2.3.2
+ *
+ */
public class ScreenParams extends RPCStruct {
public static final String KEY_RESOLUTION = "resolution";
public static final String KEY_TOUCH_EVENT_AVAILABLE = "touchEventAvailable";
+ /**
+ * Constructs a new ScreenParams object
+ */
public ScreenParams() { }
-
+ /**
+ * <p>
+ * Constructs a new ScreenParamst object indicated by the Hashtable
+ * parameter
+ * </p>
+ *
+ * @param hash
+ * The Hashtable to use
+ */
+
public ScreenParams(Hashtable<String, Object> hash) {
super(hash);
}
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScrollableMessage.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScrollableMessage.java index 3f9e75cce..2fae92ec5 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScrollableMessage.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScrollableMessage.java @@ -10,11 +10,62 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* Creates a full screen overlay containing a large block of formatted text that
* can be scrolled with up to 8 SoftButtons defined
- * <p>
- * Function Group: ScrollableMessage
- * <p>
- * <b>HMILevel needs to be FULL</b>
- * <p>
+ *
+ * <p>Function Group: ScrollableMessage</p>
+ *
+ * <p><b>HMILevel needs to be FULL</b></p>
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>scrollableMessageBody</td>
+ * <td>String</td>
+ * <td>Body of text that can include newlines and tabs.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDevice Link 1.0 </td>
+ * </tr>
+ * <tr>
+ * <td>timeout</td>
+ * <td>Integer</td>
+ * <td>App defined timeout. Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout).</td>
+ * <td>N</td>
+ * <td>minvalue=1000; maxvalue=65535; defvalue=30000</td>
+ * <td>SmartDevice Link 1.0 </td>
+ * </tr>
+ * <tr>
+ * <td>softButtons</td>
+ * <td>SoftButton</td>
+ * <td>App defined SoftButtons. If omitted on supported displays, only the system defined "Close" SoftButton will be displayed.</td>
+ * <td>N</td>
+ * <td>minsize=0; maxsize=8</td>
+ * <td>SmartDevice Link 1.0 </td>
+ * </tr>
+ * </table>
+ * <p> <b>Response</b></p>
+ *<b>Non-default Result Codes:</b>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA </p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>CHAR_LIMIT_EXCEEDED</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR </p>
+ * <p>DISALLOWED</p>
+ * <p>UNSUPPORTED_RESOURCE</p>
+ * <p>REJECTED </p>
+ * <p>ABORTED</p>
+ *
+ * @see scrollableMessageBody
+ * @see TextFieldName
*/
public class ScrollableMessage extends RPCRequest {
public static final String KEY_SCROLLABLE_MESSAGE_BODY = "scrollableMessageBody";
@@ -31,7 +82,7 @@ public class ScrollableMessage extends RPCRequest { /**
* Constructs a new ScrollableMessage object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -46,7 +97,7 @@ public class ScrollableMessage extends RPCRequest { * @param scrollableMessageBody
* a String value representing the Body of text that can include
* newlines and tabs
- * <p>
+ * <p></p>
* <b>Notes: </b>Maxlength=500
*/
public void setScrollableMessageBody(String scrollableMessageBody) {
@@ -72,7 +123,7 @@ public class ScrollableMessage extends RPCRequest { *
* @param timeout
* an Integer value representing an App defined timeout
- * <p>
+ * <p></p>
* <b>Notes</b>:Minval=0; Maxval=65535;Default=30000
*/
public void setTimeout(Integer timeout) {
@@ -99,7 +150,7 @@ public class ScrollableMessage extends RPCRequest { * @param softButtons
* a List<SoftButton> value representing App defined
* SoftButtons
- * <p>
+ * <p></p>
* <b>Notes: </b>Minsize=0, Maxsize=8
*/
public void setSoftButtons(List<SoftButton> softButtons) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScrollableMessageResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScrollableMessageResponse.java index 970782f35..880c27f95 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScrollableMessageResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScrollableMessageResponse.java @@ -22,7 +22,7 @@ public class ScrollableMessageResponse extends RPCResponse { /**
* Constructs a new ScrollableMessageResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java index ebe5c1c1a..cb5df057d 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java @@ -6,7 +6,7 @@ import com.smartdevicelink.proxy.RPCStruct; /**
* Specifies the version number of the SDL V4 interface. This is used by both the application and SDL to declare what interface version each is using.
- * <p><b> Parameter List
+ * <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -16,7 +16,7 @@ import com.smartdevicelink.proxy.RPCStruct; * </tr>
* <tr>
* <td>majorVersion</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>
* <ul>
* <li>minvalue="1"</li>
@@ -27,7 +27,7 @@ import com.smartdevicelink.proxy.RPCStruct; * </tr>
* <tr>
* <td>minorVersion</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>
* <ul>
* <li>minvalue="0"</li>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SendLocation.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SendLocation.java index 0257a4c1c..dc77058de 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SendLocation.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SendLocation.java @@ -46,8 +46,8 @@ public class SendLocation extends RPCRequest{ /** * Getter for longitude of the location to send. * - * <p><b>IMPORTANT NOTE:</b> A previous version of this method call returned a Float - * value, however, it has been changed to return a Double. This will compile, + * <p><b>IMPORTANT NOTE:</b> </p><p>A previous version of this method call returned a Float + * value, however, it has been changed to return a Double.</p> This will compile, * but cause a ClassCastException if your value is not also a Double type. * @since SmartDeviceLink v4.0 * @@ -74,8 +74,8 @@ public class SendLocation extends RPCRequest{ /** * Getter for latitude of the location to send. * - * <p><b>IMPORTANT NOTE:</b> A previous version of this method call returned a Float - * value, however, it has been changed to return a Double. This will compile, + * <p><b>IMPORTANT NOTE:</b> </p><p>A previous version of this method call returned a Float + * value, however, it has been changed to return a Double.</p> This will compile, * but cause a ClassCastException if your value is not also a Double type. * @since SmartDeviceLink v4.0 * diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetAppIcon.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetAppIcon.java index 1a5d5a22e..2cb5aef31 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetAppIcon.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetAppIcon.java @@ -8,9 +8,41 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* Used to set existing local file on SDL as the app's icon. Not supported on
* first generation SDL vehicles
- * <p>
*
+ * <p><b>Parameter List</b></p>
+ *
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>SDLFileName</td>
+ * <td>String</td>
+ * <td>File reference name.</td>
+ * <td>Y</td>
+ * <td>Maxlength=500</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ *
+ * </table>
+ *
+ *<p><b>Response </b></p>
+ *<p><b> Non-default Result Codes: </b></p>
+ *<p>SUCCESS</p>
+ * <p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p> REJECTED</p>
+ *
* @since SmartDeviceLink 2.0
+ * @see Image
*/
public class SetAppIcon extends RPCRequest {
public static final String KEY_SDL_FILE_NAME = "syncFileName";
@@ -24,7 +56,7 @@ public class SetAppIcon extends RPCRequest { /**
* Constructs a new SetAppIcon object indicated by the Hashtable parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -38,7 +70,7 @@ public class SetAppIcon extends RPCRequest { *
* @param sdlFileName
* a String value representing a file reference name
- * <p>
+ * <p></p>
* <b>Notes: </b>Maxlength=500
*/
public void setSdlFileName(String sdlFileName) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetAppIconResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetAppIconResponse.java index 9d154bebf..c6d0f7ddf 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetAppIconResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetAppIconResponse.java @@ -4,12 +4,28 @@ import java.util.Hashtable; import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCResponse;
-
+/**
+ * Set App Icon Response is sent, when SetAppIcon has been called.
+ *
+ * @since SmartDeviceLink 2.0
+ */
public class SetAppIconResponse extends RPCResponse {
+ /**
+ * Constructs a new SetAppIconResponse object
+ */
public SetAppIconResponse() {
super(FunctionID.SET_APP_ICON.toString());
}
+ /**
+ * Constructs a new SetAppIconResponse object indicated by the Hashtable
+ * parameter
+ * <p></p>
+ *
+ * @param hash
+ * The Hashtable to use
+ */
+
public SetAppIconResponse(Hashtable<String, Object> hash) {
super(hash);
}
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java index ec3b1e62e..2a3fd9d4b 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java @@ -8,8 +8,38 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* Used to set an alternate display layout. If not sent, default screen for
* given platform will be shown
- * <p>
*
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>displayLayout</td>
+ * <td>string</td>
+ * <td>Predefined or dynamically created screen layout.<p>Currently only predefined screen layouts are defined.</p> Predefined layouts include: "ONSCREEN_PRESETS" Custom screen containing app-defined onscreen presets. </td>
+ * <td>Y</td>
+ * <td>maxlength: 500</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ *
+ * </table>
+ *<p><b>Response </b></p>
+ *
+ *<p><b> Non-default Result Codes: </b></p>
+ *<p> SUCCESS </p>
+ *<p> INVALID_DATA</p>
+ *<p> OUT_OF_MEMORY</p>
+ *<p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p> REJECTED</p>
* @since SmartDeviceLink 2.0
*/
public class SetDisplayLayout extends RPCRequest {
@@ -24,7 +54,7 @@ public class SetDisplayLayout extends RPCRequest { /**
* Constructs a new SetDisplayLayout object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetDisplayLayoutResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetDisplayLayoutResponse.java index 787bdd9f7..b9947a4ac 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetDisplayLayoutResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetDisplayLayoutResponse.java @@ -28,7 +28,7 @@ public class SetDisplayLayoutResponse extends RPCResponse { /**
* Constructs a new SetDisplayLayoutResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java index be1f13bb8..7f597cafe 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java @@ -9,11 +9,100 @@ import com.smartdevicelink.proxy.RPCRequest; import com.smartdevicelink.util.DebugTool;
/**
* Sets value(s) for the specified global property(ies)
- * <p>
- * Function Group: Base <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
*
+ * <p>Function Group: Base </p>
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p><b>AudioStreamingState:</b></p>
+ * Any
+ *
+ * <p><b>SystemContext:</b></p>
+ * Any
+ *
+ *
+ * <p><b>Parameter List</b></p>
+ *
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>helpPrompt</td>
+ * <td>TTSChunk</td>
+ * <td>The help prompt. An array of text chunks of type TTSChunk. See {@linkplain TTSChunk}.The array must have at least one item.</td>
+ * <td>N</td>
+ * <td>Array must have at least one element.<p>Only optional it timeoutPrompt has been specified.</p>minsize:1; maxsize: 100</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>timeoutPrompt</td>
+ * <td>TTSChunk</td>
+ * <td>Array of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT.</td>
+ * <td>N</td>
+ * <td>Array must have at least one element. Only optional it helpPrompt has been specified <p>minsize: 1; maxsize: 100</p></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>vrHelpTitle</td>
+ * <td>string</td>
+ * <td>Text, which is shown as title of the VR help screen used in an interaction started by PTT.</td>
+ * <td>N</td>
+ * <td>If omitted on supported displays, the default SDL help title will be used. <p>If omitted and one or more vrHelp items are provided, the request will be rejected.</p>maxlength: 500</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>vrHelp</td>
+ * <td>VrHelep</td>
+ * <td>Items listed in the VR help screen used in an interaction started by PTT.</td>
+ * <td>N</td>
+ * <td>If omitted on supported displays, the default SDL VR help / What Can I Say? screen will be used<p>If the list of VR Help Items contains nonsequential positions (e.g. [1,2,4]), the RPC will be rejected.</p><p>If omitted and a vrHelpTitle is provided, the request will be rejected.</p>minsize:1; maxsize: 100 </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>menuTitle</td>
+ * <td></td>
+ * <td>Optional text to label an app menu button (for certain touchscreen platforms).</td>
+ * <td>N</td>
+ * <td>maxlength: 500</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>menuIcon</td>
+ * <td> Image</td>
+ * <td>Optional icon to draw on an app menu button (for certain touchscreen platforms).</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>keyboardProperties</td>
+ * <td>KeyboardProperties</td>
+ * <td>On-screen keybaord configuration (if available).</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ *
+ * </table>
+ *
+ * <p><b>Note: </b>Your application shall send a SetGlobalProperties to establish an advanced help prompt before sending any voice commands.</p>
+ *
+ * <p><b>Response</b></p>
+ * Indicates whether the requested Global Properties were successfully set.
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * </p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
+ * <p>DISALLOWED</p>
* @since SmartDeviceLink 1.0
* @see ResetGlobalProperties
*/
@@ -34,7 +123,7 @@ public class SetGlobalProperties extends RPCRequest { /**
* Constructs a new SetGlobalProperties object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -76,7 +165,7 @@ public class SetGlobalProperties extends RPCRequest { *
* @param helpPrompt
* a List<TTSChunk> of one or more TTSChunk elements
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>Array must have at least one element</li>
@@ -147,8 +236,8 @@ public class SetGlobalProperties extends RPCRequest { *
* @param vrHelpTitle
* a String value representing a voice recognition Help Title
- * <p>
- * <b>Notes: </b><br/>
+ * <p></p>
+ * <b>Notes: </b>
* <ul>
* <li>If omitted on supported displays, the default SDL help
* title will be used</li>
@@ -201,8 +290,8 @@ public class SetGlobalProperties extends RPCRequest { * @param vrHelp
* a List value representing items listed in the VR help screen
* used in an interaction started by PTT
- * <p>
- * <b>Notes: </b><br/>
+ * <p></p>
+ * <b>Notes: </b>
* <ul>
* <li>If omitted on supported displays, the default SmartDeviceLink VR
* help / What Can I Say? screen will be used</li>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetGlobalPropertiesResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetGlobalPropertiesResponse.java index bef494e69..f33bc0b7c 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetGlobalPropertiesResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetGlobalPropertiesResponse.java @@ -22,7 +22,7 @@ public class SetGlobalPropertiesResponse extends RPCResponse { /**
* Constructs a new SetGlobalPropertiesResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java index 2b8f33365..bd6bac324 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java @@ -8,10 +8,64 @@ import com.smartdevicelink.proxy.rpc.enums.UpdateMode; /**
* Sets the media clock/timer value and the update method (e.g.count-up,
* count-down, etc.)
- * <p>
- * Function Group: Base <p>
- * <b>HMILevel needs to be FULL, LIMITIED or BACKGROUND</b>
- * </p>
+ *
+ * <p>Function Group: Base </p>
+ * <p><b>HMILevel needs to be FULL, LIMITIED or BACKGROUND</b></p>
+ *
+ * <p><b>Parameter List</b></p>
+ *
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>startTime</td>
+ * <td>StartTime</td>
+ * <td>StartTime struct specifying hour, minute, second values to which media clock timer is set.</td>
+ * <td>N</td>
+ * <td> </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>endTime</td>
+ * <td>StartTime</td>
+ * <td> EndTime can be provided for "COUNTUP" and "COUNTDOWN"; to be used to calculate any visual progress bar (if not provided, this feature is ignored)
+ * If endTime is greater then startTime for COUNTDOWN or less than startTime for COUNTUP, then the request will return an INVALID_DATA.
+ * endTime will be ignored for "RESUME", and "CLEAR"
+ * endTime can be sent for "PAUSE", in which case it will update the paused endTime</td>
+ * <td>N</td>
+ * <td>Array must have at least one element.<p>Only optional it helpPrompt has been specified</p> minsize: 1; maxsize: 100</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>updateMode</td>
+ * <td>UpdateMode</td>
+ * <td>Specifies how the media clock/timer is to be updated (COUNTUP/COUNTDOWN/PAUSE/RESUME), based at the startTime.</td>
+ * <td>Y</td>
+ * <td>If "updateMode" is COUNTUP or COUNTDOWN, this parameter must be provided. Will be ignored for PAUSE,RESUME and CLEAR</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ *
+ * </table>
+ *
+ *<p><b>Response </b></p>
+ *
+ *<p><b> Non-default Result Codes: </b></p>
+ *
+ * <p> SUCCESS </p>
+ * <p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p> REJECTED </p>
+ * <p> IGNORED </p>
*
* @since SmartDeviceLink 1.0
*/
@@ -28,7 +82,7 @@ public class SetMediaClockTimer extends RPCRequest { /**
* Constructs a new SetMediaClockTimer object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -57,7 +111,7 @@ public class SetMediaClockTimer extends RPCRequest { *
* @param startTime
* a startTime object with specifying hour, minute, second values
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>If "updateMode" is COUNTUP or COUNTDOWN, this parameter
@@ -111,7 +165,7 @@ public class SetMediaClockTimer extends RPCRequest { *
* @param updateMode
* a Enumeration value (COUNTUP/COUNTDOWN/PAUSE/RESUME)
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>When updateMode is PAUSE, RESUME or CLEAR, the start time value
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetMediaClockTimerResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetMediaClockTimerResponse.java index 410b5b68c..e74ecc1b9 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetMediaClockTimerResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetMediaClockTimerResponse.java @@ -22,7 +22,7 @@ public class SetMediaClockTimerResponse extends RPCResponse { /**
* Constructs a new SetMediaClockTimerResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Show.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Show.java index 9782b0e7f..24307c9de 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Show.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Show.java @@ -14,19 +14,140 @@ import com.smartdevicelink.util.DebugTool; * this text area is visible to the user at the time of the request. The
* application's display text area remains unchanged until updated by subsequent
* calls to Show
- * <p>
+ * <p></p>
* The content of the application's display text area is visible to the user
* when the application's {@linkplain com.smartdevicelink.proxy.rpc.enums.HMILevel}
* is FULL or LIMITED, and the
* {@linkplain com.smartdevicelink.proxy.rpc.enums.SystemContext}=MAIN and no
* {@linkplain Alert} is in progress
- * <p>
+ * <p></p>
* The Show operation cannot be used to create an animated scrolling screen. To
* avoid distracting the driver, Show commands cannot be issued more than once
* every 4 seconds. Requests made more frequently than this will be rejected
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
+ *
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>mainField1</td>
+ * <td>String</td>
+ * <td>Text to be displayed in a single-line display, or in the upper display line in a two-line display.</td>
+ * <td>N</td>
+ * <td>If this parameter is omitted, the text of mainField1 does not change. If this parameter is an empty string, the field will be cleared. <p>Maxlength = 500</p></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>mainField2</td>
+ * <td>String</td>
+ * <td>Text to be displayed on the second display line of a two-line display.</td>
+ * <td>N</td>
+ * <td><p>If this parameter is omitted, the text of mainField2 does not change. </p> <p>If this parameter is an empty string, the field will be cleared.</p><p>If provided and the display is a single-line display, the parameter is ignored.</p>Maxlength = 500</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>mainField3</td>
+ * <td>String</td>
+ * <td>Text to be displayed on the first display line of the second page.</td>
+ * <td>N</td>
+ * <td><p>If this parameter is omitted, the text of mainField3 does not change. </p><p>If this parameter is an empty string, the field will be cleared.</p><p>If provided and the display is a single-line display, the parameter is ignored.</p> Maxlength = 500</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>mainField4</td>
+ * <td>String</td>
+ * <td>Text to be displayed on the second display line of the second page.</td>
+ * <td>N</td>
+ * <td><p>If this parameter is omitted, the text of mainField4 does not change. </p><p>If this parameter is an empty string, the field will be cleared.</p><p>If provided and the display is a single-line display, the parameter is ignored.</p>Maxlength = 500</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>alignment</td>
+ * <td>TextAlignment</td>
+ * <td>Specifies how mainField1 and mainField2 text should be aligned on display.</td>
+ * <td>N</td>
+ * <td><p>Applies only to mainField1 and mainField2 provided on this call, not to what is already showing in display.</p><p>If this parameter is omitted, text in both mainField1 and mainField2 will be centered. </p>Has no effect with navigation display</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>statusBar</td>
+ * <td>String</td>
+ * <td>The text is placed in the status bar area.</td>
+ * <td>N</td>
+ * <td><p>Note: The status bar only exists on navigation displays</p><p>If this parameter is omitted, the status bar text will remain unchanged.</p><p>If this parameter is an empty string, the field will be cleared.</p><p>If provided and the display has no status bar, this parameter is ignored.</p>Maxlength = 500</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>mediaClock</td>
+ * <td>String</td>
+ * <td><p>Text value for MediaClock field.</p> <p>Has to be properly formatted by Mobile App according to SDL capabilities.</p>If this text is set, any automatic media clock updates previously set with SetMediaClockTimer will be stopped.</td>
+ * <td>N</td>
+ * <td><p>Must be properly formatted as described in the MediaClockFormat enumeration. </p><p>If a value of five spaces is provided, this will clear that field on the display (i.e. the media clock timer field will not display anything) </p>Maxlength = 500</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>mediaTrack</td>
+ * <td>String</td>
+ * <td>Array of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT.</td>
+ * <td>N</td>
+ * <td><p>If parameter is omitted, the track field remains unchanged.</p><p>If an empty string is provided, the field will be cleared.</p><p>This field is only valid for media applications on navigation displays.</p>Maxlength = 500</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>graphic</td>
+ * <td>Image</td>
+ * <td>Image to be shown on supported displays.</td>
+ * <td>N</td>
+ * <td>If omitted on supported displays, the displayed graphic shall not change.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>secondaryGraphic</td>
+ * <td>Image</td>
+ * <td> <p>Image struct determining whether static or dynamic secondary image to display in app.</p>If omitted on supported displays, the displayed secondary graphic shall not change.</td>
+ * <td>N</td>
+ * <td> </td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
+ * <tr>
+ * <td>softButtons</td>
+ * <td>SoftButton</td>
+ * <td>Soft buttons as defined by the App</td>
+ * <td>N</td>
+ * <td><p>If omitted on supported displays, the currently displayed SoftButton values will not change.</p>Array Minsize: 0; Array Maxsize: 8</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>customPresets</td>
+ * <td>String</td>
+ * <td>Custom presets as defined by the App.</td>
+ * <td>N</td>
+ * <td><p>If omitted on supported displays, the presets will be shown as not defined.</p>Minsize: 0; Maxsize: 6</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ *
+ * </table>
+ *<p><b>Response </b></p>
+ *
+ *<p><b> Non-default Result Codes: </b></p>
+ * <p>SUCCESS </p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p> REJECTED</p>
+ * <p> DISALLOWED</p>
+ * <p> UNSUPPORTED_RESOURCE </p>
+ * <p>ABORTED</p>
*
* @since SmartDeviceLink 1.0
* @see Alert
@@ -53,7 +174,7 @@ public class Show extends RPCRequest { }
/**
* Constructs a new Show object indicated by the Hashtable parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -80,7 +201,7 @@ public class Show extends RPCRequest { * the String value representing the text displayed in a
* single-line display, or in the upper display line in a
* two-line display
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>If this parameter is omitted, the text of mainField1 does
@@ -111,7 +232,7 @@ public class Show extends RPCRequest { * @param mainField2
* the String value representing the text displayed on the second
* display line of a two-line display
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>If this parameter is omitted, the text of mainField2 does
@@ -148,7 +269,7 @@ public class Show extends RPCRequest { * @param mainField3
* the String value representing the text displayed on the first
* display line of the second page
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>If this parameter is omitted, the text of mainField3 does
@@ -186,7 +307,7 @@ public class Show extends RPCRequest { * @param mainField4
* the String value representing the text displayed on the second
* display line of the second page
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>If this parameter is omitted, the text of mainField4 does
@@ -227,7 +348,7 @@ public class Show extends RPCRequest { *
* @param alignment
* an Enumeration value
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>Applies only to mainField1 and mainField2 provided on this
@@ -258,9 +379,9 @@ public class Show extends RPCRequest { * @param statusBar
* a String representing the text you want to add in the Status
* Bar
- * <p>
+ * <p></p>
* <b>Notes: </b><i>The status bar only exists on navigation
- * displays</i><br/>
+ * displays</i>
* <ul>
* <li>If this parameter is omitted, the status bar text will
* remain unchanged</li>
@@ -292,8 +413,8 @@ public class Show extends RPCRequest { *
* @param mediaClock
* a String value for the MdaiaClock
- * <p>
- * <b>Notes: </b><br/>
+ * <p></p>
+ * <b>Notes: </b>
* <ul>
* <li>Must be properly formatted as described in the
* MediaClockFormat enumeration</li>
@@ -323,8 +444,8 @@ public class Show extends RPCRequest { *
* @param mediaTrack
* a String value disaplayed in the track field
- * <p>
- * <b>Notes: </b><br/>
+ * <p></p>
+ * <b>Notes: </b>
* <ul>
* <li>If parameter is omitted, the track field remains unchanged</li>
* <li>If an empty string is provided, the field will be cleared</li>
@@ -344,9 +465,9 @@ public class Show extends RPCRequest { *
* @param graphic
* the value representing the image shown on supported displays
- * <p>
+ * <p></p>
* <b>Notes: </b>If omitted on supported displays, the displayed
- * graphic shall not change<br/>
+ * graphic shall not change
* @since SmartDeviceLink 2.0
*/
public void setGraphic(Image graphic) {
@@ -438,8 +559,8 @@ public class Show extends RPCRequest { * @param softButtons
* a List value represemting the Soft buttons defined by the
* App
- * <p>
- * <b>Notes: </b><br/>
+ * <p></p>
+ * <b>Notes: </b>
* <ul>
* <li>If omitted on supported displays, the currently displayed
* SoftButton values will not change</li>
@@ -484,7 +605,7 @@ public class Show extends RPCRequest { * @param customPresets
* a List value representing the Custom Presets defined by the
* App
- * <p>
+ * <p></p>
* <ul>
* <li>If omitted on supported displays, the presets will be shown as not defined</li>
* <li>Array Minsize: 0</li>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ShowConstantTbt.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ShowConstantTbt.java index 293adddbe..f65e1a100 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ShowConstantTbt.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ShowConstantTbt.java @@ -8,13 +8,13 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCRequest; /** - * This RPC is used to update the user with navigation information for the constantly shown screen (base screen), but - * also for the alert type screen - * <p> - * Function Group: Navigation - * <p> - * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> - * <p> + * <p>This RPC is used to update the user with navigation information for the constantly shown screen (base screen), but + * also for the alert type screen</p> + * + * <p>Function Group: Navigation</p> + * + * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p> + * * * @since SmartDeviceLink 2.0 * @see AlertManeuver @@ -57,7 +57,7 @@ public class ShowConstantTbt extends RPCRequest{ * * @param navigationText1 * a String value representing a text for navigation text field 1 - * <p> + * <p></p> * <b>Notes: </b>Maxlength=500 */ public void setNavigationText1(String navigationText1){ @@ -83,7 +83,7 @@ public class ShowConstantTbt extends RPCRequest{ * * @param navigationText2 * a String value representing a text for navigation text field 2 - * <p> + * <p></p> * <b>Notes: </b>Maxlength=500 */ public void setNavigationText2(String navigationText2){ @@ -109,7 +109,7 @@ public class ShowConstantTbt extends RPCRequest{ * * @param eta * a String value representing a text field for estimated time of arrival - * <p> + * <p></p> * <b>Notes: </b>Maxlength=500 */ public void setEta(String eta){ @@ -135,7 +135,7 @@ public class ShowConstantTbt extends RPCRequest{ * * @param totalDistance * a String value representing a text field for total distance - * <p> + * <p></p> * <b>Notes: </b>Maxlength=500 */ public void setTotalDistance(String totalDistance){ @@ -223,7 +223,7 @@ public class ShowConstantTbt extends RPCRequest{ * * @param distanceToManeuver * a Double value representing a Fraction of distance till next maneuver - * <p> + * <p></p> * <b>Notes: </b>Minvalue=0; Maxvalue=1000000000 */ public void setDistanceToManeuver(Double distanceToManeuver){ @@ -249,7 +249,7 @@ public class ShowConstantTbt extends RPCRequest{ * * @param distanceToManeuverScale * a Double value representing a Distance till next maneuver (starting from) from previous maneuver - * <p> + * <p></p> * <b>Notes: </b>Minvalue=0; Maxvalue=1000000000 */ public void setDistanceToManeuverScale(Double distanceToManeuverScale){ @@ -271,10 +271,10 @@ public class ShowConstantTbt extends RPCRequest{ } /** - * Sets a maneuver complete flag. If and when a maneuver has completed while an AlertManeuver is active, the app - * must send this value set to TRUE in order to clear the AlertManeuver overlay<br/> - * If omitted the value will be assumed as FALSE - * <p> + * <p>Sets a maneuver complete flag. If and when a maneuver has completed while an AlertManeuver is active, the app + * must send this value set to TRUE in order to clear the AlertManeuver overlay + * If omitted the value will be assumed as FALSE</p> + * * * @param maneuverComplete * a Boolean value @@ -298,10 +298,10 @@ public class ShowConstantTbt extends RPCRequest{ } /** - * Sets Three dynamic SoftButtons available (first SoftButton is fixed to "Turns"). If omitted on supported - * displays, the currently displayed SoftButton values will not change - * <p> - * <b>Notes: </b>Minsize=0; Maxsize=3 + * <p>Sets Three dynamic SoftButtons available (first SoftButton is fixed to "Turns"). If omitted on supported + * displays, the currently displayed SoftButton values will not change</p> + * + * <p><b>Notes: </b>Minsize=0; Maxsize=3</p> * * @param softButtons * a List<SoftButton> value diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ShowResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ShowResponse.java index e12c09029..54ff95033 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ShowResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ShowResponse.java @@ -22,7 +22,7 @@ public class ShowResponse extends RPCResponse { /**
* Constructs a new ShowResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SingleTireStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SingleTireStatus.java index b9c7bafbc..ab30ff365 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SingleTireStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SingleTireStatus.java @@ -7,7 +7,7 @@ import com.smartdevicelink.proxy.rpc.enums.ComponentVolumeStatus; /**
* Tire pressure status of a single tire.
- * <p><b>Parameter List
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -19,7 +19,7 @@ import com.smartdevicelink.proxy.rpc.enums.ComponentVolumeStatus; * <td>status</td>
* <td>ComponentVolumeStatus</td>
* <td>Describes the volume status of a single tire
- * See ComponentVolumeStatus
+ * See {@linkplain ComponentVolumeStatus}
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Slider.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Slider.java index 4cf914f43..16da80dcb 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Slider.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Slider.java @@ -7,14 +7,80 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCRequest;
/**
- * Creates a full screen or pop-up overlay (depending on platform) with a single
- * user controlled slider
- * <p>
- * Function Group: Base
- * <p>
- * <b>HMILevel needs to be FULL</b>
- * <p>
+ * <p>Creates a full screen or pop-up overlay (depending on platform) with a single
+ * user controlled slider.</p>
+ *
+ * <p>Function Group: Base</p>
*
+ * <p><b>HMILevel needs to be FULL</b></p>
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>numTicks</td>
+ * <td>Integer</td>
+ * <td>Number of selectable items on a horizontal axis.</td>
+ * <td>Y</td>
+ * <td>Minvalue=2; Maxvalue=26</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ *
+ * <tr>
+ * <td>position</td>
+ * <td>Integer</td>
+ * <td>Initial position of slider control (cannot exceed numTicks),</td>
+ * <td>Y</td>
+ * <td>Minvalue=1; Maxvalue=26</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>sliderHeader</td>
+ * <td>String</td>
+ * <td>Text header to display</td>
+ * <td>N</td>
+ * <td>Maxlength=500</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>sliderFooter</td>
+ * <td>Integer</td>
+ * <td><p>Text footer to display (meant to display min/max threshold descriptors).</p>For a static text footer, only one footer string shall be provided in the array. For a dynamic text footer, the number of footer text string in the array must match the numTicks value.For a dynamic text footer, text array string should correlate with potential slider position index.If omitted on supported displays, no footer text shall be displayed.</td>
+ * <td>N</td>
+ * <td>Maxlength=500; Minvalue=1; Maxvalue=26</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ *
+ * <tr>
+ * <td>timeout</td>
+ * <td>String</td>
+ * <td>App defined timeout. Indicates how long of a timeout from the last action (i.e. sliding control resets timeout). If omitted, the value is set to 10000.</td>
+ * <td>N</td>
+ * <td>Minvalue=0; Maxvalue=65535; Defvalue= 10000</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * </table>
+*<p><b>Response </b></p>
+*
+*<p><b>Non-default Result Codes:</b></p>
+* <p> SAVED </p>
+* <p> INVALID_DATA</p>
+* <p>OUT_OF_MEMORY</p>
+* <p>TOO_MANY_PENDING_REQUESTS</p>
+* <p>APPLICATION_NOT_REGISTERED</p>
+* <p>GENERIC_ERROR</p>
+*<p> DISALLOWED</p>
+*<p> UNSUPPORTED_RESOURCE </p>
+*<p> REJECTED </p>
+* <p>ABORTED </p>
+*
* @since SmartDeviceLink 2.0
*
*/
@@ -34,7 +100,7 @@ public class Slider extends RPCRequest { /**
* Constructs a new Slider object indicated by the Hashtable parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -49,7 +115,7 @@ public class Slider extends RPCRequest { * @param numTicks
* an Integer value representing a number of selectable items on
* a horizontal axis
- * <p>
+ * <p></p>
* <b>Notes: </b>Minvalue=2; Maxvalue=26
*/
public void setNumTicks(Integer numTicks) {
@@ -76,7 +142,7 @@ public class Slider extends RPCRequest { * @param position
* an Integer value representing an Initial position of slider
* control
- * <p>
+ * <p></p>
* <b>Notes: </b>Minvalue=1; Maxvalue=26
*/
public void setPosition(Integer position) {
@@ -102,7 +168,7 @@ public class Slider extends RPCRequest { *
* @param sliderHeader
* a String value
- * <p>
+ * <p></p>
* <b>Notes: </b>Maxlength=500
*/
public void setSliderHeader(String sliderHeader) {
@@ -127,7 +193,7 @@ public class Slider extends RPCRequest { *
* @param sliderFooter
* a List<String> value representing a text footer to display
- * <p>
+ * <p></p>
* <b>Notes: </b>Maxlength=500; Minvalue=1; Maxvalue=26
*/
public void setSliderFooter(List<String> sliderFooter) {
@@ -162,7 +228,7 @@ public class Slider extends RPCRequest { *
* @param timeout
* an Integer value representing an App defined timeout
- * <p>
+ * <p></p>
* <b>Notes: </b>Minvalue=0; Maxvalue=65535; Defvalue=10000
*/
public void setTimeout(Integer timeout) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SliderResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SliderResponse.java index 6d168b6ea..0d8487d12 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SliderResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SliderResponse.java @@ -23,7 +23,7 @@ public class SliderResponse extends RPCResponse { /**
* Constructs a new SliderResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SoftButton.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SoftButton.java index 5c2cec98a..e010a08da 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SoftButton.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SoftButton.java @@ -6,7 +6,71 @@ import com.smartdevicelink.proxy.RPCStruct; import com.smartdevicelink.proxy.rpc.enums.SoftButtonType;
import com.smartdevicelink.proxy.rpc.enums.SystemAction;
import com.smartdevicelink.util.DebugTool;
-
+/**
+ * <p> A simulated button or keyboard key that is displayed on a touch screen.</p>
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>type</td>
+ * <td>SoftButtonType</td>
+ * <td>Describes, whether it is text, highlighted text, icon, or dynamic image. </td>
+ * <td></td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>text</td>
+ * <td>String</td>
+ * <td>Optional text to display (if defined as TEXT or BOTH)</td>
+ * <td>N</td>
+ * <td>Min: 0; Maxlength: 500</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>image</td>
+ * <td>Image</td>
+ * <td>Optional image struct for SoftButton (if defined as IMAGE or BOTH).</td>
+ * <td></td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>isHighlighted</td>
+ * <td>Boolean</td>
+ * <td>True, if highlighted False, if not highlighted</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>softButtonID</td>
+ * <td>Integer</td>
+ * <td>Value which is returned via OnButtonPress / OnButtonEvent</td>
+ * <td></td>
+ * <td>Min: 0; Max: 65535</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>systemAction</td>
+ * <td>SystemAction</td>
+ * <td>Parameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed.</td>
+ * <td>N</td>
+ * <td>defvalue: DEFAULT_ACTION</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ *
+ * </table>
+ *
+ */
public class SoftButton extends RPCStruct {
public static final String KEY_IS_HIGHLIGHTED = "isHighlighted";
@@ -15,7 +79,17 @@ public class SoftButton extends RPCStruct { public static final String KEY_TEXT = "text";
public static final String KEY_TYPE = "type";
public static final String KEY_IMAGE = "image";
-
+ /**
+ *
+ * <p>Constructs a new SoftButton object indicated by the Hashtable
+ * parameter</p>
+ *
+ *
+ * @param hash
+ *
+ * The Hashtable to use
+ */
+
public SoftButton() { }
public SoftButton(Hashtable<String, Object> hash) {
super(hash);
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java index f6ca43e96..e2849086c 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java @@ -5,8 +5,8 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
/**
- * Contains information about a SoftButton's capabilities.
- * <p><b>Parameter List
+ * <p>Contains information about a SoftButton's capabilities.</p>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Speak.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Speak.java index 27183af86..b5e775f06 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Speak.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Speak.java @@ -12,50 +12,50 @@ import com.smartdevicelink.proxy.RPCRequest; * (text-to-speech) engine. The provided text to be spoken can be simply a text
* phrase, or it can consist of phoneme specifications to direct SDL's TTS
* engine to speak a "speech-sculpted" phrase
- * <p>
+ * <p></p>
* Receipt of the Response indicates the completion of the Speak operation,
* regardless of how the Speak operation may have completed (i.e. successfully,
* interrupted, terminated, etc.)
- * <p>
+ * <p></p>
* Requesting a new Speak operation while the application has another Speak
* operation already in progress (i.e. no corresponding Response for that
* in-progress Speak operation has been received yet) will terminate the
* in-progress Speak operation (causing its corresponding Response to be sent by
* SDL) and begin the requested Speak operation
- * <p>
+ * <p></p>
* Requesting a new Speak operation while the application has an <i>
* {@linkplain Alert}</i> operation already in progress (i.e. no corresponding
* Response for that in-progress <i>{@linkplain Alert}</i> operation has been
* received yet) will result in the Speak operation request being rejected
* (indicated in the Response to the Request)
- * <p>
+ * <p></p>
* Requesting a new <i>{@linkplain Alert}</i> operation while the application
* has a Speak operation already in progress (i.e. no corresponding Response for
* that in-progress Speak operation has been received yet) will terminate the
* in-progress Speak operation (causing its corresponding Response to be sent by
* SDL) and begin the requested <i>{@linkplain Alert}</i> operation
- * <p>
+ * <p></p>
* Requesting a new Speak operation while the application has a <i>
* {@linkplain PerformInteraction}</i> operation already in progress (i.e. no
* corresponding Response for that in-progress <i>
* {@linkplain PerformInteraction}</i> operation has been received yet) will
* result in the Speak operation request being rejected (indicated in the
* Response to the Request)
- * <p>
+ * <p></p>
* Requesting a <i> {@linkplain PerformInteraction}</i> operation while the
* application has a Speak operation already in progress (i.e. no corresponding
* Response for that in-progress Speak operation has been received yet) will
* terminate the in-progress Speak operation (causing its corresponding Response
* to be sent by SDL) and begin the requested <i>
* {@linkplain PerformInteraction}</i> operation
- * <p>
+ * <p></p>
*
- * <b>HMI Status Requirements:</b><br/>
- * HMILevel: FULL, Limited<br/>
- * AudioStreamingState: Any<br/>
- * SystemContext: MAIN, MENU, VR
- * </p>
- * <b>Notes: </b>
+ * <p><b>HMI Status Requirements:</b></p>
+ * <p>HMILevel: FULL, Limited</p>
+ *<p> AudioStreamingState: Any</p>
+ * <p>SystemContext: MAIN, MENU, VR</p>
+ *
+ * <p><b>Notes: </b></p>
* <ul>
* <li>When <i>{@linkplain Alert}</i> is issued with MENU in effect, <i>
* {@linkplain Alert}</i> is queued and "played" when MENU interaction is
@@ -67,7 +67,43 @@ import com.smartdevicelink.proxy.RPCRequest; * VR, they are "played" back in the order in which they were queued, with all
* existing rules for "collisions" still in effect</li>
* </ul>
- * <p>
+ *
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th> Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>ttsChunks</td>
+ * <td>String</td>
+ * <td>An array of 1-100 TTSChunk structs which, taken together, specify the phrase to be spoken.</td>
+ * <td>Y</td>
+ * <td><p>The array must have 1-100 elements. </p><p>The total length of the phrase composed from the ttsChunks provided must be less than 500 characters or the request will be rejected. </p>Each chunk can be no more than 500 characters.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * </table>
+ * <p><b>Response</b> </p>
+ * <p>This Response notifies the application of the completion, interruption, or failure of a Speak Request.</p>
+ *
+ * <p><b>Non-default Result Codes:</b> </p>
+ *
+ * <p> SUCCESS </p>
+ *<p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY </p>
+ * <p>APPLICATION_NOT_REGISTERED </p>
+ * <p>TOO_MANY_PENDING_REQUESTS </p>
+ *<p> GENERIC_ERROR </p>
+ * <p>REJECTED </p>
+ * <p>DISALLOWED </p>
+ * <p>ABORTED </p>
+ *
+ * <p><b>Additional Notes:</b></p><ul>Total character limit depends on platform. Chunks are limited to 500 characters; however you can have multiple TTS chunks. On Gen 1.1 there is a total character limit of 500 characters across all chunks. This could vary according to the VCA.
*
* @since SmartDeviceLink 1.0
* @see Alert
@@ -83,7 +119,7 @@ public class Speak extends RPCRequest { }
/**
* Constructs a new Speak object indicated by the Hashtable parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -123,7 +159,7 @@ public class Speak extends RPCRequest { * @param ttsChunks
* a List<TTSChunk> value representing an array of 1-100 TTSChunk structs
* which specify the phrase to be spoken
- * <p>
+ * <p></p>
* <ul>
* <li>The array must have 1-100 elements</li>
* <li>The total length of the phrase composed from the ttsChunks
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SpeakResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SpeakResponse.java index 3e7be103c..740d24776 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SpeakResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SpeakResponse.java @@ -22,7 +22,7 @@ public class SpeakResponse extends RPCResponse { /**
* Constructs a new SpeakResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/StartTime.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/StartTime.java index 97aae52fa..bce0b9fc1 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/StartTime.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/StartTime.java @@ -6,7 +6,7 @@ import com.smartdevicelink.proxy.RPCStruct; /**
* Describes the hour, minute and second values used to set the media clock.
- * <p><b> Parameter List
+ * <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -16,21 +16,21 @@ import com.smartdevicelink.proxy.RPCStruct; * </tr>
* <tr>
* <td>hours</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>The hour. Minvalue="0", maxvalue="59"
- * <p><b>Note:</b>Some display types only support a max value of 19. If out of range, it will be rejected.
+ * <p><b>Note:</b></p>Some display types only support a max value of 19. If out of range, it will be rejected.
* </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>minutes</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>The minute. Minvalue="0", maxvalue="59".</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>seconds</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>The second. Minvalue="0", maxvalue="59".</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
@@ -55,7 +55,7 @@ public class StartTime extends RPCStruct { }
/**
* Get the hour. Minvalue="0", maxvalue="59"
- * <p><b>Note:</b>Some display types only support a max value of 19. If out of range, it will be rejected.
+ * <p><b>Note:</b></p>Some display types only support a max value of 19. If out of range, it will be rejected.
* @return hours Minvalue="0", maxvalue="59"
*/
public Integer getHours() {
@@ -63,7 +63,7 @@ public class StartTime extends RPCStruct { }
/**
* Set the hour. Minvalue="0", maxvalue="59"
- * <p><b>Note:</b>Some display types only support a max value of 19. If out of range, it will be rejected.
+ * <p><b>Note:</b></p>Some display types only support a max value of 19. If out of range, it will be rejected.
* @param hours min: 0; max: 59
*/
public void setHours( Integer hours ) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeButton.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeButton.java index 9f09fb5fa..7f1f92bae 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeButton.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeButton.java @@ -6,52 +6,70 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCRequest;
import com.smartdevicelink.proxy.rpc.enums.ButtonName;
/**
- * Establishes a subscription to button notifications for HMI buttons. Buttons
+ *<p> Establishes a subscription to button notifications for HMI buttons. Buttons
* are not necessarily physical buttons, but can also be "soft" buttons on a
* touch screen, depending on the display in the vehicle. Once subscribed to a
* particular button, an application will receive both
* {@linkplain OnButtonEvent} and {@linkplain OnButtonPress} notifications
* whenever that button is pressed. The application may also unsubscribe from
* notifications for a button by invoking the {@linkplain UnsubscribeButton}
- * operation
- * <p>
- * When a button is depressed, an {@linkplain OnButtonEvent} notification is
+ * operation</p>
+ *
+ * <p>When a button is depressed, an {@linkplain OnButtonEvent} notification is
* sent to the application with a ButtonEventMode of BUTTONDOWN. When that same
* button is released, an {@linkplain OnButtonEvent} notification is sent to the
- * application with a ButtonEventMode of BUTTONUP
- * <p>
- * When the duration of a button depression (that is, time between depression
+ * application with a ButtonEventMode of BUTTONUP</p>
+ *
+ * <p>When the duration of a button depression (that is, time between depression
* and release) is less than two seconds, an {@linkplain OnButtonPress}
* notification is sent to the application (at the moment the button is
* released) with a ButtonPressMode of SHORT. When the duration is two or more
* seconds, an {@linkplain OnButtonPress} notification is sent to the
* application (at the moment the two seconds have elapsed) with a
- * ButtonPressMode of LONG
- * <p>
+ * ButtonPressMode of LONG</p>
+ *
* The purpose of {@linkplain OnButtonPress} notifications is to allow for
* programmatic detection of long button presses similar to those used to store
* presets while listening to the radio, for example
- * <p>
- * When a button is depressed and released, the sequence in which notifications
- * will be sent to the application is as follows:
- * <p>
- * For short presses:<br/>
+ *
+ * <p>When a button is depressed and released, the sequence in which notifications
+ * will be sent to the application is as follows:</p>
+ *
+ * <p>For short presses:</p>
* <ul>
* <li>OnButtonEvent (ButtonEventMode = BUTTONDOWN)</li>
* <li>OnButtonEvent (ButtonEventMode = BUTTONUP)</li>
* <li>OnButtonPress (ButtonPressMode = SHORT)</li>
* </ul>
- * <p>
- * For long presses:<br/>
+ *
+ * <p>For long presses:</p>
* <ul>
* <li>OnButtonEvent (ButtonEventMode = BUTTONDOWN)</li>
* <li>OnButtonEvent (ButtonEventMode = BUTTONUP)</li>
* <li>OnButtonPress (ButtonPressMode = LONG)</li>
* </ul>
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
*
+ *<p> <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>buttonName</td>
+ * <td>ButtonName</td>
+ * <td>Name of the button to subscribe.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0 </td>
+ * </tr>
+ * </table>
* @since SmartDeviceLink 1.0
* @see UnsubscribeButton
*/
@@ -65,9 +83,9 @@ public class SubscribeButton extends RPCRequest { super(FunctionID.SUBSCRIBE_BUTTON.toString());
}
/**
- * Constructs a new SubscribeButton object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new SubscribeButton object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeButtonResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeButtonResponse.java index b51f75eee..81fca78c2 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeButtonResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeButtonResponse.java @@ -20,9 +20,9 @@ public class SubscribeButtonResponse extends RPCResponse { }
/**
- * Constructs a new SubscribeButtonResponse object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new SubscribeButtonResponse object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java index 10333d3d0..6b934ef21 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java @@ -11,11 +11,227 @@ import com.smartdevicelink.proxy.RPCRequest; * onVehicleData notification whenever new data is available. The update rate is
* very much dependent on sensors, vehicle architecture and vehicle type. Be
* also prepared for the situation that a signal is not available on a vehicle
- * <p>
- * Function Group: Location, VehicleInfo and DrivingChara
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
+ *
+ * <p>Function Group: Location, VehicleInfo and DrivingChara</p>
+ *
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>SmartDeviceLink Version</th>
+ * </tr>
+ * <tr>
+ * <td>gps</td>
+ * <td>Boolean</td>
+ * <td>GPS data. See {@linkplain GPSData}for details</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>speed</td>
+ * <td>Boolean</td>
+ * <td>The vehicle speed in kilometers per hour</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>rpm</td>
+ * <td>Boolean</td>
+ * <td>The number of revolutions per minute of the engine</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel</td>
+ * <td>Boolean</td>
+ * <td>The fuel level in the tank (percentage)</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel_State</td>
+ * <td>Boolean</td>
+ * <td>The fuel level state</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>instantFuelConsumption</td>
+ * <td>Boolean</td>
+ * <td>The instantaneous fuel consumption in microlitres</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>externalTemperature</td>
+ * <td>Boolean</td>
+ * <td>The external temperature in degrees celsius</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>prndl</td>
+ * <td>Boolean</td>
+ * <td>Currently selected gear.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>tirePressure</td>
+ * <td>Boolean</td>
+ * <td>Tire pressure status</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>odometer</td>
+ * <td>Boolean</td>
+ * <td>Odometer in km</td>
+ * <td>N</td>
+ * <td>Max Length: 500</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>beltStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the seat belts</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>bodyInformation</td>
+ * <td>Boolean</td>
+ * <td>The body information including ignition status and internal temp</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>deviceStatus</td>
+ * <td>Boolean</td>
+ * <td>The device status including signal and battery strength</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>driverBraking</td>
+ * <td>Boolean</td>
+ * <td>The status of the brake pedal</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>wiperStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the wipers</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>headLampStatus</td>
+ * <td>Boolean</td>
+ * <td>Status of the head lamps</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>engineTorque</td>
+ * <td>Boolean</td>
+ * <td>Torque value for engine (in Nm) on non-diesel variants</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>accPedalPosition</td>
+ * <td>Boolean</td>
+ * <td>Accelerator pedal position (percentage depressed)</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>steeringWheelAngle</td>
+ * <td>Boolean</td>
+ * <td>Current angle of the steering wheel (in deg)</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>eCallInfo</td>
+ * <td>Boolean</td>
+ * <td>Emergency Call notification and confirmation data.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>airbagStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the air bags.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>emergencyEvent</td>
+ * <td>Boolean</td>
+ * <td>Information related to an emergency event (and if it occurred).</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>clusterModeStatus</td>
+ * <td>Boolean</td>
+ * <td>The status modes of the instrument panel cluster.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>myKey</td>
+ * <td>Boolean</td>
+ * <td>Information related to the MyKey feature.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * </table>
+ *
+ * <p> <b>Response</b></p>
+ *<p><b>Non-default Result Codes:</b></p>
+ *<p>SUCCESS</p>
+ *<p>WARNINGS </p>
+ *<p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>IGNORED </p>
+ * <p>DISALLOWED</p>
+ * <p>USER_DISALLOWED </p>
*
* @since SmartDeviceLink 2.0
* @see UnsubscribeVehicleData
@@ -55,9 +271,9 @@ public class SubscribeVehicleData extends RPCRequest { }
/**
- * Constructs a new SubscribeVehicleData object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new SubscribeVehicleData object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java index 327e0f7d6..f8092cae8 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java @@ -45,9 +45,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { }
/**
- * Constructs a new SubscribeVehicleDataResponse object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new SubscribeVehicleDataResponse object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SystemRequest.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SystemRequest.java index 94fe62353..14164b964 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SystemRequest.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SystemRequest.java @@ -6,12 +6,50 @@ import java.util.List; import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCRequest;
import com.smartdevicelink.proxy.rpc.enums.RequestType;
+/** An asynchronous request from the device; binary data can be included in hybrid part of message for some requests (such as HTTP, Proprietary, or Authentication requests)
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>requestType</td>
+ * <td>RequestType</td>
+ * <td>The type of system request. Note that Proprietary requests should forward the binary data to the known proprietary module on the system.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ *
+ * <tr>
+ * <td>fileName</td>
+ * <td>String</td>
+ * <td>Filename of HTTP data to store in predefined system staging area. Mandatory if requestType is HTTP. PROPRIETARY requestType should ignore this parameter. </td>
+ * <td>N</td>
+ * <td>Max Length: 255</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * </table>
+ * @since SmartDeviceLink 3.0
+ *
+ *
+ *
+ */
public class SystemRequest extends RPCRequest {
public static final String KEY_FILE_NAME = "fileName";
public static final String KEY_REQUEST_TYPE = "requestType";
public static final String KEY_DATA = "data";
-
+ /**
+ * Constructs a new SystemRequest object
+ */
+
public SystemRequest() {
super(FunctionID.SYSTEM_REQUEST.toString());
}
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SystemRequestResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SystemRequestResponse.java index 201c186c8..6fc920f1e 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SystemRequestResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SystemRequestResponse.java @@ -5,6 +5,11 @@ import java.util.Hashtable; import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCResponse;
+/**
+ * System Request Response is sent, when SystemRequest has been called
+ *
+ * @since SmartDeviceLink 3.0
+ */
public class SystemRequestResponse extends RPCResponse {
public SystemRequestResponse() {
super(FunctionID.SYSTEM_REQUEST.toString());
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TTSChunk.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TTSChunk.java index 05bac01ab..97f865903 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TTSChunk.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TTSChunk.java @@ -6,15 +6,15 @@ import com.smartdevicelink.proxy.RPCStruct; import com.smartdevicelink.proxy.rpc.enums.SpeechCapabilities;
/**
- * Specifies what is to be spoken. This can be simply a text phrase, which SDL will speak according to its own rules.
+ * <p>Specifies what is to be spoken. This can be simply a text phrase, which SDL will speak according to its own rules.
* It can also be phonemes from either the Microsoft SAPI phoneme set, or from the LHPLUS phoneme set.
- * It can also be a pre-recorded sound in WAV format (either developer-defined, or provided by the SDL platform).
+ * It can also be a pre-recorded sound in WAV format (either developer-defined, or provided by the SDL platform).</p>
*
* <p>In SDL, words, and therefore sentences, can be built up from phonemes and are used to explicitly provide the proper pronounciation to the TTS engine.
* For example, to have SDL pronounce the word "read" as "red", rather than as when it is pronounced like "reed",
- * the developer would use phonemes to express this desired pronounciation.
- * <p>For more information about phonemes, see <a href="http://en.wikipedia.org/wiki/Phoneme">http://en.wikipedia.org/wiki/Phoneme</a>.
- * <p><b> Parameter List
+ * the developer would use phonemes to express this desired pronounciation.</p>
+ * <p>For more information about phonemes, see <a href="http://en.wikipedia.org/wiki/Phoneme">http://en.wikipedia.org/wiki/Phoneme</a></p>.
+ * <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TextField.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TextField.java index ed128e0f5..918f0eb2f 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TextField.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TextField.java @@ -8,7 +8,7 @@ import com.smartdevicelink.proxy.rpc.enums.TextFieldName; /**
* Struct defining the characteristics of a displayed field on the HMI.
- * <p><b> Parameter List
+ * <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -30,7 +30,7 @@ import com.smartdevicelink.proxy.rpc.enums.TextFieldName; * </tr>
* <tr>
* <td>width</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>The number of characters in one row of this field.
* <ul>
* <li>Minvalue="1"</li>
@@ -41,7 +41,7 @@ import com.smartdevicelink.proxy.rpc.enums.TextFieldName; * </tr>
* <tr>
* <td>rows</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>The number of rows for this text field.
* <ul>
* <li>Minvalue="1"</li>
@@ -52,6 +52,15 @@ import com.smartdevicelink.proxy.rpc.enums.TextFieldName; * </tr>
* </table>
* @since SmartDeviceLink 1.0
+ *
+ * @see TextFieldName
+ * @see Alert
+ * @see Show
+ * @see PerformInteraction
+ * @see ScrollableMessage
+ * @see PerformAudioPassThru
+ * @see ShowConstantTBT
+ *
*/
public class TextField extends RPCStruct {
public static final String KEY_WIDTH = "width";
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TireStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TireStatus.java index 4f42f7d25..f853d673c 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TireStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TireStatus.java @@ -5,6 +5,67 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.WarningLightStatus;
import com.smartdevicelink.util.DebugTool;
+/** <p>The status and pressure of the tires.</p>
+ * <p><b> Parameter List:</b></p>
+ *
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>PressureTellTale</td>
+ * <td>WarningLightStatus</td>
+ * <td>Status of the Tire Pressure TellTale</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>LeftFront</td>
+ * <td>SingleTireStatus</td>
+ * <td>The status of the left front tire.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>RightFront</td>
+ * <td>SingleTireStatus</td>
+ * <td>The status of the right front tire.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>LeftRear</td>
+ * <td>SingleTireStatus</td>
+ * <td>The status of the left rear tire.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>RightRear</td>
+ * <td>SingleTireStatus</td>
+ * <td>The status of the right rear tire</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>InnerLeftRear</td>
+ * <td>SingleTireStatus</td>
+ * <td>The status of the inner left rear tire.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>InnerRightRear</td>
+ * <td>SingleTireStatus</td>
+ * <td>The status of the inner right rear tire.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * </table>
+ *
+ * @since SmartDeviceLink 2.0
+ *
+ * @see WarningLightStatus
+ * @see SingleTireStatus
+ * @see GetVehicleData
+ * @see OnVehicleData
+ */
public class TireStatus extends RPCStruct {
public static final String KEY_PRESSURE_TELL_TALE = "pressureTellTale";
@@ -14,6 +75,14 @@ public class TireStatus extends RPCStruct { public static final String KEY_INNER_LEFT_REAR = "innerLeftRear";
public static final String KEY_INNER_RIGHT_REAR = "innerRightRear";
public static final String KEY_RIGHT_REAR = "rightRear";
+ /**
+ * <p>Constructs a new TireStatus object indicated by the Hashtable parameter</p>
+ *
+ *
+ * @param hash
+ * <p>
+ * The Hashtable to use</p>
+ */
public TireStatus() { }
public TireStatus(Hashtable<String, Object> hash) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchCoord.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchCoord.java index 104db308d..95f793fe6 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchCoord.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchCoord.java @@ -3,12 +3,58 @@ package com.smartdevicelink.proxy.rpc; import com.smartdevicelink.proxy.RPCStruct;
import java.util.Hashtable;
+/**
+ * <p>The x or y coordinate of the touch.</p>
+ *
+ *
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th> Version</th>
+ * </tr>
+ * <tr>
+ * <td>x</td>
+ * <td>Integer</td>
+ * <td>The x coordinate of the touch.</td>
+ * <td>Y</td>
+ * <td>minvalue = 0; maxvalue = 10000</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>y</td>
+ * <td>Integer</td>
+ * <td>The y coordinate of the touch.</td>
+ * <td>Y</td>
+ * <td>minvalue = 0; maxvalue = 10000</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * </table>
+ *@see SoftButtonCapabilities
+ *@see ButtonCapabilities
+ *@see OnButtonPress
+ *
+ *@since SmartDeviceLink 3.0
+ */
public class TouchCoord extends RPCStruct {
public static final String KEY_X = "x";
public static final String KEY_Y = "y";
public TouchCoord() {}
-
+ /**
+ * <p>Constructs a new TouchCoord object indicated by the Hashtable parameter</p>
+ *
+ *
+ * @param hash
+ * <p>
+ * The Hashtable to use</p>
+ */
+
public TouchCoord(Hashtable<String, Object> hash) {
super(hash);
}
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchEvent.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchEvent.java index a204fae8e..76e3c4207 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchEvent.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchEvent.java @@ -5,6 +5,54 @@ import java.util.Hashtable; import java.util.List;
import com.smartdevicelink.proxy.RPCStruct;
+/**
+ * <p>For touchscreen interactions, the mode of how the choices are presented.</p>
+ *
+ * <p><b>Parameter List</b></p>
+ *
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>id</td>
+ * <td>Integer</td>
+ * <td> A touch's unique identifier. The application can track the current touch events by id. If a touch event has type begin, the id should be added to the set of touches. If a touch event has type end, the id should be removed from the set of touches.</td>
+ * <td>N</td>
+ * <td>Min Value: 0; Max Value: 9</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>ts</td>
+ * <td>Float</td>
+ * <td>The time that the touch was recorded. <p> This number can the time since the beginning of the session or something else as long as the units are in milliseconds.</p>
+ * <p>The timestamp is used to determined the rate of change of position of a touch.</p><p>The application also uses the time to verify whether two touches,with different ids, are part of a single action by the user.</p>
+ * <p>If there is only a single timestamp in this array,</p> it is the same for every coordinate in the coordinates array.</td>
+ * <td>Y</td>
+ * <td>minvalue="0" maxvalue="5000000000" minsize="1" maxsize="1000"</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>c</td>
+ * <td>Integer</td>
+ * <td>The coordinates of the screen area where the touch event occurred.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 3.0</td>
+ * </tr>
+ * </table>
+ *
+ * @since SmartDeviceLink 3.0
+ *
+ * @see SoftButtonCapabilities
+ * @see ButtonCapabilities
+ * @see OnButtonPress
+ */
public class TouchEvent extends RPCStruct {
public static final String KEY_ID = "id";
@@ -12,7 +60,14 @@ public class TouchEvent extends RPCStruct { public static final String KEY_C = "c";
public TouchEvent() { }
-
+ /**
+ * <p>Constructs a new TouchEvent object indicated by the Hashtable parameter</p>
+ *
+ *
+ * @param hash
+ * <p>
+ * The Hashtable to use</p>
+ */
public TouchEvent(Hashtable<String, Object> hash) {
super(hash);
}
@@ -29,8 +84,18 @@ public class TouchEvent extends RPCStruct { return (Integer) store.get(KEY_ID);
}
- @SuppressWarnings("unchecked")
+ /**
+ * Use getTimestamps
+ * @deprecated 4.0.2
+ * @return
+ */
+ @Deprecated
public List<Long> getTs() {
+ return getTimestamps();
+ }
+
+ @SuppressWarnings("unchecked")
+ public List<Long> getTimestamps() {
if(store.get(KEY_TS) instanceof List<?>){
List<?> list = (List<?>)store.get(KEY_TS);
if(list != null && list.size()>0){
@@ -51,16 +116,35 @@ public class TouchEvent extends RPCStruct { return null;
}
- public void setTs(List<Long> ts) {
- if (ts != null) {
+ public void setTimestamps(List<Long> ts){
+ if (ts != null) {
store.put(KEY_TS, ts);
} else {
store.remove(KEY_TS);
}
}
- @SuppressWarnings("unchecked")
+ /**
+ * Use setTimestamps.
+ * @deprecated 4.0.2
+ * @param ts
+ */
+ @Deprecated
+ public void setTs(List<Long> ts) {
+ setTimestamps(ts);
+ }
+
+ /**
+ * Use getTouchCoordinates
+ * @deprecated 4.0.2
+ * @return
+ */
+ @Deprecated
public List<TouchCoord> getC() {
+ return getTouchCoordinates();
+ }
+ @SuppressWarnings("unchecked")
+ public List<TouchCoord> getTouchCoordinates() {
if (store.get(KEY_C) instanceof List<?>) {
List<?> list = (List<?>)store.get(KEY_C);
if (list != null && list.size() > 0) {
@@ -79,7 +163,17 @@ public class TouchEvent extends RPCStruct { return null;
}
+ /**
+ * Use setTouchCoordinates
+ * @deprecated 4.0.2
+ * @return
+ */
+ @Deprecated
public void setC( List<TouchCoord> c ) {
+ setTouchCoordinates(c);
+ }
+
+ public void setTouchCoordinates( List<TouchCoord> c ) {
if (c != null) {
store.put(KEY_C, c );
} else {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java index 0daee4844..b67e5b61a 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java @@ -3,7 +3,46 @@ package com.smartdevicelink.proxy.rpc; import com.smartdevicelink.proxy.RPCStruct;
import java.util.Hashtable;
-
+/**
+ * Types of screen touch events available in screen area.
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>SmartDeviceLink Version</th>
+ * </tr>
+ * <tr>
+ * <td>pressAvailable</td>
+ * <td>Boolean</td>
+ * <td></td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>multiTouchAvailable</td>
+ * <td>Boolean</td>
+ * <td></td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>doublePressAvailable</td>
+ * <td>Boolean</td>
+ * <td></td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * </table>
+ *
+ */
public class TouchEventCapabilities extends RPCStruct {
public static final String KEY_PRESS_AVAILABLE = "pressAvailable";
public static final String KEY_MULTI_TOUCH_AVAILABLE = "multiTouchAvailable";
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Turn.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Turn.java index 1bfb8652c..437e176a5 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Turn.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Turn.java @@ -6,8 +6,8 @@ import com.smartdevicelink.proxy.RPCStruct; /** * Describes a navigation turn including an optional icon - * <p> - * <b>Parameter List + * + * <p><b>Parameter List</p> * <table border="1" rules="all"> * <tr> * <th>Name</th> diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnregisterAppInterface.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnregisterAppInterface.java index aafdb53f9..8db9e032f 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnregisterAppInterface.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnregisterAppInterface.java @@ -10,14 +10,216 @@ import com.smartdevicelink.proxy.RPCRequest; * dispose of all resources associated with the application's interface
* registration (e.g. Command Menu items, Choice Sets, button subscriptions,
* etc.)
- * <p>
- * After the UnregisterAppInterface operation is performed, no other operations
+ *
+ * <p>After the UnregisterAppInterface operation is performed, no other operations
* can be performed until a new app interface registration is established by
- * calling <i>{@linkplain RegisterAppInterface}</i>
- * <p>
- * <b>HMILevel can be FULL, LIMITED, BACKGROUND or NONE</b>
- * </p>
+ * calling <i>{@linkplain RegisterAppInterface}</i></p>
+ *
+ * <p><b>HMILevel can be FULL, LIMITED, BACKGROUND or NONE</b></p>
*
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>SmartDeviceLink Version</th>
+ * </tr>
+ * <tr>
+ * <td>gps</td>
+ * <td>Boolean</td>
+ * <td>GPS data. See {@linkplain GPSData} for details</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>speed</td>
+ * <td>Boolean</td>
+ * <td>The vehicle speed in kilometers per hour</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>rpm</td>
+ * <td>Boolean</td>
+ * <td>The number of revolutions per minute of the engine</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel</td>
+ * <td>Boolean</td>
+ * <td>The fuel level in the tank (percentage)</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel_State</td>
+ * <td>Boolean</td>
+ * <td>The fuel level state</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>instantFuelConsumption</td>
+ * <td>Boolean</td>
+ * <td>The instantaneous fuel consumption in microlitres</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>externalTemperature</td>
+ * <td>Boolean</td>
+ * <td>The external temperature in degrees celsius</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>prndl</td>
+ * <td>Boolean</td>
+ * <td>Currently selected gear.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>tirePressure</td>
+ * <td>Boolean</td>
+ * <td>Tire pressure status</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>odometer</td>
+ * <td>Boolean</td>
+ * <td>Odometer in km</td>
+ * <td>N</td>
+ * <td>Max Length: 500</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>beltStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the seat belts</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>bodyInformation</td>
+ * <td>Boolean</td>
+ * <td>The body information including ignition status and internal temp</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>deviceStatus</td>
+ * <td>Boolean</td>
+ * <td>The device status including signal and battery strength</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>driverBraking</td>
+ * <td>Boolean</td>
+ * <td>The status of the brake pedal</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>wiperStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the wipers</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>headLampStatus</td>
+ * <td>Boolean</td>
+ * <td>Status of the head lamps</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>engineTorque</td>
+ * <td>Boolean</td>
+ * <td>Torque value for engine (in Nm) on non-diesel variants</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>accPedalPosition</td>
+ * <td>Boolean</td>
+ * <td>Accelerator pedal position (percentage depressed)</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>steeringWheelAngle</td>
+ * <td>Boolean</td>
+ * <td>Current angle of the steering wheel (in deg)</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>eCallInfo</td>
+ * <td>Boolean</td>
+ * <td>Emergency Call notification and confirmation data.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>airbagStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the air bags.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>emergencyEvent</td>
+ * <td>Boolean</td>
+ * <td>Information related to an emergency event (and if it occurred).</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>clusterModeStatus</td>
+ * <td>Boolean</td>
+ * <td>The status modes of the instrument panel cluster.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>myKey</td>
+ * <td>Boolean</td>
+ * <td>Information related to the MyKey feature.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * </table>
* @see RegisterAppInterface
* @see OnAppInterfaceUnregistered
*/
@@ -29,9 +231,9 @@ public class UnregisterAppInterface extends RPCRequest { super(FunctionID.UNREGISTER_APP_INTERFACE.toString());
}
/**
- * Constructs a new UnregisterAppInterface object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new UnregisterAppInterface object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnregisterAppInterfaceResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnregisterAppInterfaceResponse.java index db425a503..d77bf3b39 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnregisterAppInterfaceResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnregisterAppInterfaceResponse.java @@ -22,7 +22,7 @@ public class UnregisterAppInterfaceResponse extends RPCResponse { /**
* Constructs a new UnregisterAppInterfaceResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java index 7575fd84a..33567a8af 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java @@ -9,13 +9,43 @@ import com.smartdevicelink.proxy.rpc.enums.ButtonName; /**
* Deletes a subscription to button notifications for the specified button. For
* more information about button subscriptions, see {@linkplain SubscribeButton}
- * <p>
- * Application can unsubscribe from a button that is currently being pressed
- * (i.e. has not yet been released), but app will not get button event
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * <p>
*
+ * <p>Application can unsubscribe from a button that is currently being pressed
+ * (i.e. has not yet been released), but app will not get button event</p>
+ *
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>buttonName</td>
+ * <td>ButtonName</td>
+ * <td>Name of the button to unsubscribe.</td>
+ * <td>Y</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * </table>
+ *
+ * <p> <b>Response</b></p>
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR </p>
+ * <p>UNSUPPORTED_RESOURCE</p>
+ * <p>IGNORED</p>
+ * <p>REJECTED</p>
* @since SmartDeviceLink 1.0
* @see SubscribeButton
*/
@@ -31,7 +61,7 @@ public class UnsubscribeButton extends RPCRequest { /**
* Constructs a new UnsubscribeButton object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeButtonResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeButtonResponse.java index 58f7326e1..7efc00955 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeButtonResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeButtonResponse.java @@ -22,7 +22,7 @@ public class UnsubscribeButtonResponse extends RPCResponse { /**
* Constructs a new UnsubscribeButtonResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java index 429049d59..668b31fd9 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java @@ -8,12 +8,224 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* This function is used to unsubscribe the notifications from the
* subscribeVehicleData function
- * <p>
- * Function Group: Location, VehicleInfo and DrivingChara
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
+ * <p>Function Group: Location, VehicleInfo and DrivingChara</p>
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
*
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>gps</td>
+ * <td>Boolean</td>
+ * <td>GPS data. See {@linkplain GPSdata} for details</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>speed</td>
+ * <td>Boolean</td>
+ * <td>The vehicle speed in kilometers per hour</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>rpm</td>
+ * <td>Boolean</td>
+ * <td>The number of revolutions per minute of the engine</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel</td>
+ * <td>Boolean</td>
+ * <td>The fuel level in the tank (percentage)</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel_State</td>
+ * <td>Boolean</td>
+ * <td>The fuel level state</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>instantFuelConsumption</td>
+ * <td>Boolean</td>
+ * <td>The instantaneous fuel consumption in microlitres</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>externalTemperature</td>
+ * <td>Boolean</td>
+ * <td>The external temperature in degrees celsius</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>prndl</td>
+ * <td>Boolean</td>
+ * <td>Currently selected gear.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>tirePressure</td>
+ * <td>Boolean</td>
+ * <td>Tire pressure status</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>odometer</td>
+ * <td>Boolean</td>
+ * <td>Odometer in km</td>
+ * <td>N</td>
+ * <td>Max Length: 500</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>beltStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the seat belts</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>bodyInformation</td>
+ * <td>Boolean</td>
+ * <td>The body information including ignition status and internal temp</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>deviceStatus</td>
+ * <td>Boolean</td>
+ * <td>The device status including signal and battery strength</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>driverBraking</td>
+ * <td>Boolean</td>
+ * <td>The status of the brake pedal</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>wiperStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the wipers</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>headLampStatus</td>
+ * <td>Boolean</td>
+ * <td>Status of the head lamps</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>engineTorque</td>
+ * <td>Boolean</td>
+ * <td>Torque value for engine (in Nm) on non-diesel variants</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>accPedalPosition</td>
+ * <td>Boolean</td>
+ * <td>Accelerator pedal position (percentage depressed)</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>steeringWheelAngle</td>
+ * <td>Boolean</td>
+ * <td>Current angle of the steering wheel (in deg)</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>eCallInfo</td>
+ * <td>Boolean</td>
+ * <td>Emergency Call notification and confirmation data.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>airbagStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the air bags.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>emergencyEvent</td>
+ * <td>Boolean</td>
+ * <td>Information related to an emergency event (and if it occurred).</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>clusterModeStatus</td>
+ * <td>Boolean</td>
+ * <td>The status modes of the instrument panel cluster.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>myKey</td>
+ * <td>Boolean</td>
+ * <td>Information related to the MyKey feature.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * </table>
+ * <p><b> Response</b></p>
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>WARNINGS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>IGNORED</p>
+ * <p>DISALLOWED</p>
+ *
* @since SmartDeviceLink 2.0
* @see SubscribeVehicleData
* @see GetVehicleData
@@ -55,7 +267,7 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Constructs a new UnsubscribeVehicleData object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java index 9d2cbf5bb..92d9a46df 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java @@ -7,7 +7,7 @@ import com.smartdevicelink.proxy.RPCResponse; import com.smartdevicelink.util.DebugTool;
/**
- * Unsubscribe Vehicle Data Response is sent, when UnsubscribeVehicleData has been called
+ * Unsubscribe Vehicle Data Response is sent, when UnsubscribeVehicleData has been called.
*
* @since SmartDeviceLink 2.0
*/
@@ -47,7 +47,7 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { /**
* Constructs a new UnsubscribeVehicleDataResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UpdateTurnList.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UpdateTurnList.java index fd4f88fa8..ad2b41163 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UpdateTurnList.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UpdateTurnList.java @@ -10,11 +10,11 @@ import com.smartdevicelink.proxy.RPCRequest; /** * Updates the list of next maneuvers, which can be requested by the user pressing the softbutton "Turns" on the * Navigation base screen. Three softbuttons are predefined by the system: Up, Down, Close - * <p> - * Function Group: Navigation - * <p> - * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> - * <p> + * + * <p>Function Group: Navigation</p> + * + * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p> + * * * @since SmartDeviceLink 2.0 * @see ShowConstantTbt @@ -49,7 +49,7 @@ public class UpdateTurnList extends RPCRequest{ * @param turnList * a List<Turn> value representing a list of turns to be shown to the user * <p> - * <b>Notes: </b>Minsize=1; Maxsize=100 + * <b>Notes: </b>Minsize=1; Maxsize=100</p> */ public void setTurnList(List<Turn> turnList){ if(turnList != null){ @@ -119,7 +119,7 @@ public class UpdateTurnList extends RPCRequest{ * @param softButtons * a List<SoftButton> value * <p> - * <b>Notes: </b><br/> + * <b>Notes: </b></p> * <ul> * <li>If omitted on supported displays, the alert will not have any SoftButton</li> * <li>ArrayMin: 0</li> diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VehicleDataResult.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VehicleDataResult.java index 8939b4895..ef466d727 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VehicleDataResult.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VehicleDataResult.java @@ -5,10 +5,52 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.VehicleDataResultCode;
import com.smartdevicelink.proxy.rpc.enums.VehicleDataType;
-
+/**
+ *
+ * Individual published data request result.
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>dataType</td>
+ * <td>VehicleDataType</td>
+ * <td>Defined published data element type.</td>
+ * <td></td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>resultCode</td>
+ * <td>VehicleDataResultCode</td>
+ * <td>Published data result code.</td>
+ * <td></td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * </table>
+ *
+ */
public class VehicleDataResult extends RPCStruct {
public static final String KEY_DATA_TYPE = "dataType";
public static final String KEY_RESULT_CODE = "resultCode";
+ /**
+ * <p>
+ * Constructs a new VehicleDataResult object indicated by the Hashtable
+ * parameter
+ * </p>
+ *
+ * @param hash
+ *
+ * <p>The Hashtable to use</p>
+ */
public VehicleDataResult() { }
public VehicleDataResult(Hashtable<String, Object> hash) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VehicleType.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VehicleType.java index 9de42c598..3f30774c4 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VehicleType.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VehicleType.java @@ -6,7 +6,7 @@ import com.smartdevicelink.proxy.RPCStruct; /**
* Describes the type of vehicle the mobile phone is connected with.
- * <p><b>Parameter List
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VrHelpItem.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VrHelpItem.java index bb77f3ebd..f195b4cae 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VrHelpItem.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VrHelpItem.java @@ -4,11 +4,61 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.util.DebugTool;
-
+/**
+ *
+ * VR help items i.e. the text strings to be displayed, and when pronounced by the user the recognition of any of which must trigger the corresponding VR command.
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th> Req.</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>text</td>
+ * <td>String</td>
+ * <td>Text to display for VR Help item</td>
+ * <td>Y</td>
+ * <td>maxlength: 500</td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
+ * <tr>
+ * <td>image</td>
+ * <td>Image</td>
+ * <td>Image struct for VR Help item</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
+ * <tr>
+ * <td>position</td>
+ * <td>Integer</td>
+ * <td>Position to display item in VR Help list</td>
+ * <td>N</td>
+ * <td> minvalue=1; maxvalue=100</td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
+ * </table>
+ *
+ */
public class VrHelpItem extends RPCStruct {
public static final String KEY_POSITION = "position";
public static final String KEY_TEXT = "text";
public static final String KEY_IMAGE = "image";
+ /**
+ * <p>
+ * Constructs a new VrHelpItem object indicated by the Hashtable
+ * parameter
+ * </p>
+ *
+ * @param hash
+ * <p>
+ * The Hashtable to use
+ */
public VrHelpItem() { }
public VrHelpItem(Hashtable<String, Object> hash) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AmbientLightStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AmbientLightStatus.java index 82eff5574..3f4076b11 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AmbientLightStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AmbientLightStatus.java @@ -1,4 +1,13 @@ package com.smartdevicelink.proxy.rpc.enums;
+/** Reflects the status of the ambient light sensor.
+ *
+ * @since SmartDeviceLink 2.3.2
+ *
+ * @see SoftButtonCapabilities
+ * @see ButtonCapabilities
+ * @see OnButtonPress
+ *
+ */
public enum AmbientLightStatus {
NIGHT,
@@ -9,6 +18,11 @@ public enum AmbientLightStatus { DAY,
UNKNOWN,
INVALID;
+ /**
+ * Convert String to AmbientLightStatus
+ * @param value String
+ * @return AmbientLightStatus
+ */
public static AmbientLightStatus valueForString(String value) {
try{
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AppInterfaceUnregisteredReason.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AppInterfaceUnregisteredReason.java index 617fe9796..d4a7ff103 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AppInterfaceUnregisteredReason.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AppInterfaceUnregisteredReason.java @@ -83,7 +83,11 @@ public enum AppInterfaceUnregisteredReason { */
PROTOCOL_VIOLATION,
;
-
+ /**
+ * Convert String to AppInterfaceUnregisteredReason
+ * @param value String
+ * @return AppInterfaceUnregisteredReason
+ */
public static AppInterfaceUnregisteredReason valueForString(String value) {
try{
return valueOf(value);
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AudioStreamingState.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AudioStreamingState.java index d332a560f..50accb6bf 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AudioStreamingState.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AudioStreamingState.java @@ -30,6 +30,11 @@ public enum AudioStreamingState { * @since SmartDeviceLink 1.0
*/
NOT_AUDIBLE;
+ /**
+ * Convert String to AudioStreamingState
+ * @param value String
+ * @return AudioStreamingState
+ */
public static AudioStreamingState valueForString(String value) {
try{
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AudioType.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AudioType.java index 853a3951b..d340e0e4c 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AudioType.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AudioType.java @@ -3,6 +3,11 @@ package com.smartdevicelink.proxy.rpc.enums; /**
* Describes different audio type options for PerformAudioPassThru
*
+ * @see SoftButtonCapabilities
+ * @see ButtonCapabilities
+ * @see OnButtonPress
+ * @since SmartDeviceLink 2.0
+
*/
public enum AudioType {
/**
@@ -11,6 +16,11 @@ public enum AudioType { * @since SmartDeviceLink 2.0
*/
PCM;
+ /**
+ * Convert String to AudioType
+ * @param value String
+ * @return AudioType
+ */
public static AudioType valueForString(String value) {
try{
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/BitsPerSample.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/BitsPerSample.java index 7065e7ade..b21e138a9 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/BitsPerSample.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/BitsPerSample.java @@ -3,8 +3,9 @@ package com.smartdevicelink.proxy.rpc.enums; import java.util.EnumSet;
/**
- * Describes different bit depth options for PerformAudioPassThru
- *
+ * Describes different bit depth options for PerformAudioPassThru.
+ * @see PerformAudioPassThru
+ * @since SmartDeviceLink 2.0
*/
public enum BitsPerSample {
/**
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ButtonEventMode.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ButtonEventMode.java index ad0301f10..33f1f0f49 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ButtonEventMode.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ButtonEventMode.java @@ -3,8 +3,9 @@ package com.smartdevicelink.proxy.rpc.enums; /**
* Indicates whether the button was depressed or released. A BUTTONUP event will
* always be preceded by a BUTTONDOWN event
- * <p>
*
+ * @see SoftButtonCapabilities
+ * @see OnButtonEvent
* @since SmartDeviceLink 1.0
*/
public enum ButtonEventMode {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ButtonPressMode.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ButtonPressMode.java index 8d6b7115b..cc2852526 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ButtonPressMode.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ButtonPressMode.java @@ -1,10 +1,10 @@ package com.smartdevicelink.proxy.rpc.enums;
/**
- * Indicates whether this is a LONG or SHORT button press
- * <p>
- *
- * @since SmartDeviceLink 1.0
+ * Indicates whether this is a LONG or SHORT button press.
+ * <p></p>
+ *@see ButtonEventMode
+ *@since SmartDeviceLink 1.0
*/
public enum ButtonPressMode {
/**
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/CarModeStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/CarModeStatus.java index e24a2f8d0..c44b457ec 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/CarModeStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/CarModeStatus.java @@ -1,10 +1,33 @@ package com.smartdevicelink.proxy.rpc.enums;
+/** Describes the carmode the vehicle is in.
+ * @see SoftButtonCapabilities
+ * @see ButtonCapabilities
+ * @see OnButtonPress
+ * @since SmartDeviceLink 2.0
+ */
public enum CarModeStatus {
+ /** Provides carmode NORMAL to each module.
+ */
+
NORMAL,
+ /** Provides carmode FACTORY to each module.
+ */
+
FACTORY,
+ /** Provides carmode TRANSPORT to each module.
+ */
+
TRANSPORT,
+ /** Provides carmode CRASH to each module.
+ */
+
+
CRASH;
+ /** Convert String to CarModeStatus
+ * @param value String
+ * @return CarModeStatus
+ */
public static CarModeStatus valueForString(String value) {
try{
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/DisplayType.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/DisplayType.java index bf3e58118..4ff5a1bbb 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/DisplayType.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/DisplayType.java @@ -1,15 +1,64 @@ package com.smartdevicelink.proxy.rpc.enums;
+/** The type of the display.
+ *
+ *
+ * @since SmartDevcieLink 1.0
+ *
+ */
public enum DisplayType {
+ /**
+ * Center Information Display.
+ *This display type provides a 2-line x 20 character "dot matrix" display.
+ *
+ */
+
CID("CID"),
+ /** TYPE II display.
+ 1 line older radio head unit. */
+
TYPE2("TYPE2"),
+ /**
+ * TYPE V display
+ Old radio head unit.
+
+ */
+
TYPE5("TYPE5"),
+ /**
+ * Next Generation Navigation display.
+ */
+
NGN("NGN"),
+ /**
+ * GEN-2, 8 inch display.
+ */
+
GEN2_8_DMA("GEN2_8_DMA"),
+ /**
+ * GEN-2, 6 inch display.
+ */
+
GEN2_6_DMA("GEN2_6_DMA"),
+ /**
+ * 3 inch GEN1.1 display.
+ */
+
MFD3("MFD3"),
+ /**
+ * 4 inch GEN1.1 display
+ */
+
MFD4("MFD4"),
+ /**
+ * 5 inch GEN1.1 display.
+ */
+
MFD5("MFD5"),
+ /**
+ * GEN-3, 8 inch display.
+ */
+
GEN3_8_INCH("GEN3_8-INCH");
private final String INTERNAL_NAME;
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ECallConfirmationStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ECallConfirmationStatus.java index 26408bcab..b7a341d9e 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ECallConfirmationStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ECallConfirmationStatus.java @@ -1,12 +1,39 @@ package com.smartdevicelink.proxy.rpc.enums;
+/** Reflects the status of the eCall Notification.
+ * <p>
+ *
+ * @since SmartDeviceLink 2.0
+ *
+ */
public enum ECallConfirmationStatus {
+ /**
+ * No E-Call signal triggered.
+ */
NORMAL,
+ /**
+ * An E-Call is being in progress.
+ */
CALL_IN_PROGRESS,
+ /**
+ * An E-Call was cancelled by the user.
+ */
CALL_CANCELLED,
+ /**
+ * The E-Call sequence is completed.
+ */
CALL_COMPLETED,
+ /**
+ * An E-Call could not be connected.
+ */
CALL_UNSUCCESSFUL,
+ /**
+ * E-Call is not configured on this vehicle.
+ */
ECALL_CONFIGURED_OFF,
+ /**
+ * E-Call is considered to be complete without Emergency Operator contact.
+ */
CALL_COMPLETE_DTMF_TIMEOUT;
public static ECallConfirmationStatus valueForString(String value) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/EmergencyEventType.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/EmergencyEventType.java index 98fd5dfce..374a6c7e2 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/EmergencyEventType.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/EmergencyEventType.java @@ -1,15 +1,36 @@ package com.smartdevicelink.proxy.rpc.enums;
-
+/**
+ *
+ * Reflects the emergency event status of the vehicle.
+ *
+ */
public enum EmergencyEventType {
-
+ /** No emergency event has happened.
+ */
NO_EVENT,
+ /** Frontal collision has happened.
+ */
FRONTAL,
+ /** Side collision has happened.
+ */
SIDE,
+ /**Rear collision has happened.
+ */
REAR,
+ /** A rollover event has happened.
+ */
ROLLOVER,
+ /** The signal is not supported
+ */
NOT_SUPPORTED,
+ /** Emergency status cannot be determined
+ */
FAULT;
-
+ /**
+ * Convert String to EmergencyEventType
+ * @param value String
+ * @return EmergencyEventTpe
+ */
public static EmergencyEventType valueForString(String value) {
try{
return valueOf(value);
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/FileType.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/FileType.java index 704afd118..54e5ce8b8 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/FileType.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/FileType.java @@ -1,7 +1,7 @@ package com.smartdevicelink.proxy.rpc.enums;
/**
- * Enumeration listing possible file tpyes.
+ * Enumeration listing possible file types.
* @since SmartDeviceLink 2.0
*/
public enum FileType {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/FuelCutoffStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/FuelCutoffStatus.java index 53dd82583..266f13afb 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/FuelCutoffStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/FuelCutoffStatus.java @@ -1,10 +1,27 @@ package com.smartdevicelink.proxy.rpc.enums;
-
+/** Reflects the status of the Restraints Control Module fuel pump cutoff.<br> The fuel pump is cut off typically after the vehicle has had a collision.
+ * <p>
+ *
+ * @since SmartDeviceLink 2.0
+ *
+ */
public enum FuelCutoffStatus {
+ /** Fuel is cut off
+ */
TERMINATE_FUEL,
+ /** Fuel is not cut off
+ *
+ */
NORMAL_OPERATION,
+ /** Status of the fuel pump cannot be determined
+ *
+ */
FAULT;
-
+ /**
+ * Convert String to FuelCutoffStatus
+ * @param value String
+ * @return FuelCuttoffStatus
+ */
public static FuelCutoffStatus valueForString(String value) {
try{
return valueOf(value);
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/GlobalProperty.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/GlobalProperty.java index 767355e46..a54d53d1d 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/GlobalProperty.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/GlobalProperty.java @@ -13,10 +13,30 @@ public enum GlobalProperty{ * The prompt to be spoken if the user-initiated interaction times out waiting for the user's verbal input.
*/
TIMEOUTPROMPT,
+ /**
+ * The property vrHelpTitle of setGlobalProperties
+ */
+
VRHELPTITLE,
+ /**
+ * The property array of vrHelp of setGlobalProperties
+ */
+
VRHELPITEMS,
+ /**
+ * The property in-app menu name of setGlobalProperties
+ */
+
MENUNAME,
+ /**
+ * The property in-app menu icon of setGlobalProperties
+ */
+
MENUICON,
+ /**
+ * The on-screen keyboard configuration of setGlobalProperties
+ */
+
KEYBOARDPROPERTIES;
/**
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/HMILevel.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/HMILevel.java index 8f2da6991..8757a26ec 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/HMILevel.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/HMILevel.java @@ -4,7 +4,7 @@ import java.util.EnumSet; /**
* Specifies current level of the HMI. An HMI level indicates the degree of user interaction possible through the HMI (e.g. TTS only, display only, VR, etc.). The HMI level varies for an application based on the type of display (i.e. Nav or non-Nav) and the user directing "focus" to other applications (e.g. phone, other mobile applications, etc.)
- * <p>
+ *
* @since SmartDeviceLink 1.0
*/
public enum HMILevel {
@@ -17,7 +17,7 @@ public enum HMILevel { */
HMI_LIMITED("LIMITED"),
/**
- * App cannot interact with user via TTS, VR, Display or Button Presses. App can perform the following operations:<br/>
+ * App cannot interact with user via TTS, VR, Display or Button Presses. App can perform the following operations:
* <ul>
* <li>Operation {@linkplain com.smartdevicelink.proxy.rpc.AddCommand}</li>
* <li>Operation {@linkplain com.smartdevicelink.proxy.rpc.DeleteCommand}</li>
@@ -35,7 +35,7 @@ public enum HMILevel { */
HMI_BACKGROUND("BACKGROUND"),
/**
- * Application has been discovered by SDL, but application cannot send any requests or receive any notifications<br/>
+ * Application has been discovered by SDL, but application cannot send any requests or receive any notifications
* An HMILevel of NONE can also mean that the user has exited the application by saying "exit appname" or selecting "exit" from the application's menu. When this happens, the application still has an active interface registration with SDL and all SDL resources the application has created (e.g. Choice Sets, subscriptions, etc.) still exist. But while the HMILevel is NONE, the application cannot send any messages to SDL, except <i>{@linkplain com.smartdevicelink.proxy.rpc.UnregisterAppInterface}</li>
*/
HMI_NONE("NONE");
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/HmiZoneCapabilities.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/HmiZoneCapabilities.java index e148fb347..4725b4ff4 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/HmiZoneCapabilities.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/HmiZoneCapabilities.java @@ -3,6 +3,7 @@ package com.smartdevicelink.proxy.rpc.enums; /**
* Specifies HMI Zones in the vehicle.
*
+ * @since SmartDeviceLink 1.0
*/
public enum HmiZoneCapabilities {
/**
@@ -17,6 +18,11 @@ public enum HmiZoneCapabilities { * @since SmartDeviceLink 1.0
*/
BACK;
+ /**
+ * Convert String to HMIZoneCapabilities
+ * @param value String
+ * @return HMIZoneCapabilities
+ */
public static HmiZoneCapabilities valueForString(String value) {
try{
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/IgnitionStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/IgnitionStatus.java index 81f2093c8..b17ccf1cf 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/IgnitionStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/IgnitionStatus.java @@ -1,7 +1,7 @@ package com.smartdevicelink.proxy.rpc.enums;
/**
- * Reflects the status of ignition..
+ * Reflects the status of ignition.
* @since SmartDeviceLink 2.0
*/
public enum IgnitionStatus {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ImageFieldName.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ImageFieldName.java index 34971d10d..bf92ef5f4 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ImageFieldName.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ImageFieldName.java @@ -1,16 +1,64 @@ package com.smartdevicelink.proxy.rpc.enums;
-
+/**
+ * The name that identifies the field.
+ *
+ * @since SmartDeviceLink 2.3.2
+ */
public enum ImageFieldName {
+ /** The image field for SoftButton
+ *
+ */
+
softButtonImage,
+ /** The first image field for Choice.
+ *
+ */
+
choiceImage,
+ /** The secondary image field for Choice.
+ *
+ */
+
choiceSecondaryImage,
+ /** The image field for vrHelpItem.
+ *
+ */
+
vrHelpItem,
+ /** The image field for Turn.
+ *
+ */
+
turnIcon,
+ /** The image field for the menu icon in SetGlobalProperties.
+ *
+ */
+
menuIcon,
+ /** The image filed for AddCommand.
+ *
+ */
+
cmdIcon,
+ /** The image field for the app icon ( set by setAppIcon).
+ *
+ */
+
appIcon,
+ /** The image filed for Show.
+ *
+ */
+
graphic,
+ /** The primary image field for ShowConstant TBT.
+ *
+ */
+
showConstantTBTIcon,
+
+ /** The secondary image field for ShowConstant TBT.
+ *
+ */ showConstantTBTNextTurnIcon,
/**
* The optional image of a destination / location
@@ -20,6 +68,11 @@ public enum ImageFieldName { locationImage,
;
+ /**
+ * Convert String to ImageFieldName
+ * @param value String
+ * @return ImageFieldName
+ */
public static ImageFieldName valueForString(String value) {
try{
return valueOf(value);
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/InteractionMode.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/InteractionMode.java index c20bc7386..98b61a1f2 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/InteractionMode.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/InteractionMode.java @@ -33,12 +33,12 @@ public enum InteractionMode { * recognized choice), the interaction becomes strictly, and irreversibly, a
* VR_ONLY interaction (i.e. the MANUAL_ONLY mode forms of interaction will
* no longer be honored)
- * <P>
- * The TriggerSource parameter of the
+ *
+ * <p>The TriggerSource parameter of the
* {@linkplain com.smartdevicelink.proxy.rpc.PerformInteraction} response will
* indicate which interaction mode the user finally chose to attempt the
* selection (even if the interaction did not end with a selection being
- * made)
+ * made)</P>
*/
BOTH;
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/KeyboardEvent.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/KeyboardEvent.java index 524ee632c..7a730377d 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/KeyboardEvent.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/KeyboardEvent.java @@ -1,16 +1,39 @@ package com.smartdevicelink.proxy.rpc.enums;
-
+/**
+ * Enumeration listing possible keyboard events.
+ *
+ *
+ */
public enum KeyboardEvent {
+ /** The use has pressed the keyboard key (applies to both SINGLE_KEYPRESS and RESEND_CURRENT_ENTRY modes).
+ *
+ */
KEYPRESS,
+ /** The User has finished entering text from the keyboard and submitted the entry.
+ *
+ */
+
ENTRY_SUBMITTED,
+ /** The User has pressed the HMI-defined "Cancel" button.
+ *
+ */
+
ENTRY_CANCELLED,
+ /** The User has not finished entering text and the keyboard is aborted with the event of higher priority.
+ *
+ */ ENTRY_ABORTED,
/**
* @since SmartDeviceLink 4.0
*/
ENTRY_VOICE,
;
+ /**
+ * Convert String to KeyboardEvent
+ * @param value String
+ * @return KeyboardEvent
+ */
public static KeyboardEvent valueForString(String value) {
try{
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/KeyboardLayout.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/KeyboardLayout.java index 6f1155a53..2cd71b3f3 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/KeyboardLayout.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/KeyboardLayout.java @@ -1,5 +1,9 @@ package com.smartdevicelink.proxy.rpc.enums;
-
+/**
+ * Enumeration listing possible keyboard layouts.
+ *
+ * @since SmartDeviceLink 2.3.2
+ */
public enum KeyboardLayout {
QWERTY,
QWERTZ,
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/KeypressMode.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/KeypressMode.java index cbfeed24d..32e198585 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/KeypressMode.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/KeypressMode.java @@ -1,8 +1,21 @@ package com.smartdevicelink.proxy.rpc.enums;
-
+/**
+ * Enumeration listing possible keyboard events.
+ *
+ *
+ */
public enum KeypressMode {
+ /**
+ * Each keypress is individually sent as the user presses the keyboard keys.
+ */
SINGLE_KEYPRESS,
+ /**
+ * The keypresses are queued and a string is eventually sent once the user chooses to submit their entry.
+ */
QUEUE_KEYPRESSES,
+ /**
+ * The keypresses are queue and a string is sent each time the user presses a keyboard key; the string contains the entire current entry.
+ */
RESEND_CURRENT_ENTRY;
public static KeypressMode valueForString(String value) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/Language.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/Language.java index 69fee7402..5f0a0b88f 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/Language.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/Language.java @@ -4,35 +4,131 @@ import java.util.EnumSet; /**
* Specifies the language to be used for TTS, VR, displayed messages/menus
- * <p>
+ *
*
* @since SmartDeviceLink 1.0
*
*/
public enum Language {
+ /**
+ * English - US
+ */
+
EN_US("EN-US"),
+ /**
+ * Spanish - Mexico
+ */
+
ES_MX("ES-MX"),
+ /**
+ * French - Canada
+ */
+
FR_CA("FR-CA"),
+ /**
+ * German - Germany
+ */
+
DE_DE("DE-DE"),
+ /**
+ * Spanish - Spain
+ */
+
ES_ES("ES-ES"),
+ /**
+ * English - GB
+ */
+
EN_GB("EN-GB"),
+ /**
+ * Russian - Russia
+ */
+
RU_RU("RU-RU"),
+ /**
+ * Turkish - Turkey
+ */
+
TR_TR("TR-TR"),
+ /**
+ * Polish - Poland
+ */
+
PL_PL("PL-PL"),
+ /**
+ * French - France
+ */
+
FR_FR("FR-FR"),
+ /**
+ * Italian - Italy
+ */
+
IT_IT("IT-IT"),
+ /**
+ * Swedish - Sweden
+ */
+
SV_SE("SV-SE"),
+ /**
+ * Portuguese - Portugal
+ */
+
PT_PT("PT-PT"),
+ /**
+ * Dutch (Standard) - Netherlands
+ */
+
NL_NL("NL-NL"),
+ /**
+ * English - Australia
+ */
+
EN_AU("EN-AU"),
+ /**
+ * Mandarin - China
+ */
+
ZH_CN("ZH-CN"),
+ /**
+ * Mandarin - Taiwan
+ */
+
ZH_TW("ZH-TW"),
+ /**
+ * Japanese - Japan
+ */
+
JA_JP("JA-JP"),
+ /**
+ * Arabic - Saudi Arabia
+ */
+
AR_SA("AR-SA"),
+ /**
+ * Korean - South Korea
+ */
+
KO_KR("KO-KR"),
+ /**
+ * Portuguese - Brazil
+ */
+
PT_BR("PT-BR"),
+ /**
+ * Czech - Czech Republic
+ */
+
CS_CZ("CS-CZ"),
+ /**
+ * Danish - Denmark
+ */
+
DA_DK("DA-DK"),
+ /**
+ * Norwegian - Norway
+ */
+
NO_NO("NO-NO");
private final String INTERNAL_NAME;
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/LayoutMode.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/LayoutMode.java index 25783b1dc..b64cf1bb3 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/LayoutMode.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/LayoutMode.java @@ -1,10 +1,29 @@ package com.smartdevicelink.proxy.rpc.enums;
-
+/**
+ * For touchscreen interactions, the mode of how the choices are presented.
+ *
+ *
+ */
public enum LayoutMode {
+ /**
+ * This mode causes the interaction to display the previous set of choices as icons.
+ */
ICON_ONLY,
+ /**
+ * This mode causes the interaction to display the previous set of choices as icons along with a search field in the HMI.
+ */
ICON_WITH_SEARCH,
+ /**
+ * This mode causes the interaction to display the previous set of choices as a list
+ */
LIST_ONLY,
+ /**
+ * This mode causes the interaction to display the previous set of choices as a list along with a search field in the HMI.
+ */
LIST_WITH_SEARCH,
+ /**
+ * This mode causes the interaction to immediately display a keyboard entry through the HMI.
+ */
KEYBOARD;
public static LayoutMode valueForString(String value) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/LockScreenStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/LockScreenStatus.java index 740e262a8..ba25a3024 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/LockScreenStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/LockScreenStatus.java @@ -1,8 +1,24 @@ package com.smartdevicelink.proxy.rpc.enums;
-
+/**
+ *
+ * Status of the Lock Screen.
+ *
+ */
public enum LockScreenStatus {
+ /**
+ * LockScreen is Required
+ */
+
REQUIRED,
+ /**
+ * LockScreen is Optional
+ */
+
OPTIONAL,
+ /**
+ * LockScreen is Not Required
+ */
+
OFF;
public static LockScreenStatus valueForString(String value) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/MediaClockFormat.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/MediaClockFormat.java index f76ef9b3d..2bf84744a 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/MediaClockFormat.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/MediaClockFormat.java @@ -2,8 +2,8 @@ package com.smartdevicelink.proxy.rpc.enums; /**
* Indicates the format of the time displayed on the connected SDL unit.Format
- * description follows the following nomenclature:<br> Sp = Space<br> | = or <br>c =
- * character
+ * description follows the following nomenclature:<p> Sp = Space</p> <p>| = or </p><p>c =
+ * character</p>
*
* @since SmartDeviceLink 1.0
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/PowerModeQualificationStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/PowerModeQualificationStatus.java index 381a0293e..c268e14aa 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/PowerModeQualificationStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/PowerModeQualificationStatus.java @@ -1,10 +1,36 @@ package com.smartdevicelink.proxy.rpc.enums;
+/** Reflects the status of the current power mode qualification.
+ *
+ * @since SmartDeviceLink 2.0
+ *
+ */
public enum PowerModeQualificationStatus {
+ /** The power mode of the vehicle is currently considered undefined
+ *
+ */
+
POWER_MODE_UNDEFINED,
+ /** The evaluation of the power mode is in progress
+ *
+ */
+
POWER_MODE_EVALUATION_IN_PROGRESS,
+ /** Currently undefined
+ *
+ */
+
NOT_DEFINED,
+ /** The power mode of the vehicle
+ *
+ */
+
POWER_MODE_OK;
+ /**
+ * Convert String to PowerModeQualificationStatus
+ * @param value String
+ * @return PowerModeQualificationStatus
+ */
public static PowerModeQualificationStatus valueForString(String value) {
try{
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/PowerModeStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/PowerModeStatus.java index 342130784..06ed3ba9a 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/PowerModeStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/PowerModeStatus.java @@ -1,14 +1,41 @@ package com.smartdevicelink.proxy.rpc.enums;
-
+/** Reflects the status of the current power mode.
+ *
+ * @since SmartDeviceLink 2.0
+ *
+ */
public enum PowerModeStatus {
+ /** Key not inserted
+ *
+ */
KEY_OUT,
+ /** Key is currently out
+ *
+ */
KEY_RECENTLY_OUT,
+
KEY_APPROVED_0,
POST_ACCESORY_0,
+ /** Key is in accessory positon
+ *
+ */
+
ACCESORY_1,
POST_IGNITION_1,
+
+ /** Key is in position ignition on
+ *
+ */
IGNITION_ON_2,
+ /** Key is in position running
+ *
+ */
+
RUNNING_2,
+ /** Key is in crank position
+ *
+ */
+
CRANK_3;
public static PowerModeStatus valueForString(String value) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/PrerecordedSpeech.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/PrerecordedSpeech.java index 331d8eb00..2b27040a6 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/PrerecordedSpeech.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/PrerecordedSpeech.java @@ -1,11 +1,20 @@ package com.smartdevicelink.proxy.rpc.enums;
-
+/**
+ * Contains a list of Pre-recorded speech items present on the platform.
+ *
+ *
+ */
public enum PrerecordedSpeech {
HELP_JINGLE,
INITIAL_JINGLE,
LISTEN_JINGLE,
POSITIVE_JINGLE,
NEGATIVE_JINGLE;
+ /**
+ * Convert String to PrerecordedSpeech
+ * @param value String
+ * @return PrerecordedSpeech
+ */
public static PrerecordedSpeech valueForString(String value) {
try{
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/RequestType.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/RequestType.java index 5d8198884..0ddcfef3a 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/RequestType.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/RequestType.java @@ -1,5 +1,9 @@ package com.smartdevicelink.proxy.rpc.enums;
-
+/**
+ * Enumeration listing possible asynchronous requests.
+ *
+ *
+ */
public enum RequestType {
HTTP,
@@ -65,7 +69,11 @@ public enum RequestType { */
FOTA, ;
-
+ /**
+ * Convert String to RequestType
+ * @param value String
+ * @return RequestType
+ */
public static RequestType valueForString(String value) {
try{
return valueOf(value);
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/Result.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/Result.java index 557069c15..870e4115e 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/Result.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/Result.java @@ -3,7 +3,7 @@ package com.smartdevicelink.proxy.rpc.enums; /**
* Defines the possible result codes returned by SDL to the application in a
* Response to a requested operation
- * <p>
+ *
*
* @since SmartDeviceLink 1.0
*/
@@ -13,7 +13,7 @@ public enum Result { */
SUCCESS,
/**
- * The data sent is invalid. For example:<br/>
+ * <p>The data sent is invalid. For example:</p>
* <ul>
* <li>Invalid Json syntax</li>
* <li>Parameters out of bounds (number or enum range)</li>
@@ -39,7 +39,7 @@ public enum Result { */
TOO_MANY_PENDING_REQUESTS,
/**
- * One of the provided IDs is not valid. For example:<br/>
+ * <p>One of the provided IDs is not valid. For example:</p>
* <ul>
* <li>CorrelationID</li>
* <li>CommandID</li>
@@ -169,6 +169,11 @@ public enum Result { * The provided hash ID does not match the hash of the current set of registered data or the core could not resume the previous data.
*/
RESUME_FAILED;
+ /**
+ * Convert String to Result
+ * @param value String
+ * @return Result
+ */
public static Result valueForString(String value) {
try{
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SamplingRate.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SamplingRate.java index 4af196487..e659ff165 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SamplingRate.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SamplingRate.java @@ -4,7 +4,7 @@ import java.util.EnumSet; /**
* Describes different sampling rates for PerformAudioPassThru
- *
+ * @since SmartDeviceLink 2.0
*/
public enum SamplingRate {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SoftButtonType.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SoftButtonType.java index 454b4ed77..29fa27020 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SoftButtonType.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SoftButtonType.java @@ -1,10 +1,24 @@ package com.smartdevicelink.proxy.rpc.enums;
import java.util.EnumSet;
-
+/** The enumeration defines the types of the soft buttons to be displayed on UI component:<p>The text is displayed on the soft button</p>
+ *<p>The image is displayed on the soft button</p>
+ *<p>Both image and text are displayed on the soft button.</p>
+ *
+ * @since SmartDeviceLink 2.0
+ */
public enum SoftButtonType {
+ /** Text displayed
+ *
+ */
SBT_TEXT("TEXT"),
+ /** Image displayed
+ *
+ */
SBT_IMAGE("IMAGE"),
+ /** Image displayed
+ *
+ */
SBT_BOTH("BOTH");
private final String INTERNAL_NAME;
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SpeechCapabilities.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SpeechCapabilities.java index 4b80d12c7..2b5d17740 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SpeechCapabilities.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SpeechCapabilities.java @@ -11,10 +11,31 @@ public enum SpeechCapabilities { * @since SmartDeviceLink 1.0
*/
TEXT,
+ /**
+ * The SDL platform can interpret and speak LHPLUS phonemes
+ */
+
SAPI_PHONEMES,
+
+ /**
+ * The SDL platform can interpret and speak LHPLUS phonemes
+ */
+
LHPLUS_PHONEMES,
+ /**
+ * The SDL platform can play pre-recorded sounds as part of a TTS operation.<p>(e.g. Speak, Alert, PerformInteraction, etc.).</p>
+ */
PRE_RECORDED,
+ /**
+ * The SDL platform can play the prerecorded sound of 1 second of silence (i.e. no sound at all).
+ */
+
SILENCE;
+ /**
+ * Convert String to SpeechCapabilities
+ * @param value String
+ * @return SpeechCapabilities
+ */
public static SpeechCapabilities valueForString(String value) {
try{
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SystemAction.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SystemAction.java index 58c4e2bbc..835e9b1b9 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SystemAction.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SystemAction.java @@ -1,9 +1,31 @@ package com.smartdevicelink.proxy.rpc.enums;
+/** Enumeration that describes system actions that can be triggered.
+ *
+ * @since SmartDeviceLink 2.0
+ *
+ */
public enum SystemAction {
+ /** Default action occurs. Standard behavior (e.g. SoftButton clears overlay).
+ *
+ */
+
DEFAULT_ACTION,
+ /** App is brought into HMI_FULL.
+ *
+ */
+
STEAL_FOCUS,
+ /** Current system context is maintained. An overlay is persisted even though a SoftButton has been pressed and the notification sent.
+ *
+ */
+
KEEP_CONTEXT;
+ /**
+ * Convert String to SystemAction
+ * @param value String
+ * @return SystemAction
+ */
public static SystemAction valueForString(String value) {
try{
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/TBTState.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/TBTState.java index 457c8ed59..d334ccad7 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/TBTState.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/TBTState.java @@ -9,14 +9,50 @@ public enum TBTState { * Indicates that driver requested a route update.
*/
ROUTE_UPDATE_REQUEST,
+ /**
+ * Confirmation from HMI about accepting the route.
+ */
+
ROUTE_ACCEPTED,
+ /**
+ * Information from HMI about the route refusal.
+ */
+
ROUTE_REFUSED,
+ /**
+ * Information from HMI about canceling the route.
+ */
+
ROUTE_CANCELLED,
+ /**
+ * Request from HMI for Estimated time of arrival.
+ */
+
ETA_REQUEST,
+ /**
+ * Request from HMI for the information of the next turn.
+ */
+
NEXT_TURN_REQUEST,
+ /**
+ * Request from HMI for the route status.
+ */
+
ROUTE_STATUS_REQUEST,
+ /**
+ * Request from HMI for the route summary.
+ */
+
ROUTE_SUMMARY_REQUEST,
+ /**
+ * Request from HMI for the information about trip status.
+ */
+
TRIP_STATUS_REQUEST,
+ /**
+ * Request from HMI for the timeout for waiting for the route updating.
+ */
+
ROUTE_UPDATE_REQUEST_TIMEOUT;
/**
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/TextFieldName.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/TextFieldName.java index 073741e3a..ded9d0571 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/TextFieldName.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/TextFieldName.java @@ -1,29 +1,129 @@ package com.smartdevicelink.proxy.rpc.enums;
+/** Names of the text fields that can appear on the display.
+ *
+ * @since SmartDeviceLink 1.0
+ *
+ */
public enum TextFieldName {
+ /** The first line of first set of main fields of the persistent display; applies to "Show"
+ *
+ */
+
mainField1,
+ /** The second line of first set of main fields of the persistent display; applies to "Show"
+ *
+ */
+
mainField2,
+ /** The first line of second set of main fields of persistent display; applies to "Show"
+ *
+ */
+
mainField3,
+ /** The second line of second set of main fields of the persistent display; applies to "Show"
+ *
+ */
+
mainField4,
+ /** The status bar on NGN; applies to "Show"
+ *
+ */
+
statusBar,
+ /** Text value for MediaClock field; applies to "Show"
+ *
+ */
+
mediaClock,
+ /** The track field of NGN and GEN1.1 MFD displays. This field is only available for media applications; applies to "Show"
+ *
+ */
+
mediaTrack,
+ /** The first line of the alert text field; applies to "Alert"
+ *
+ */
+
alertText1,
+ /** The second line of the alert text field; applies to "Alert"
+ *
+ */
+
alertText2,
+ /** The third line of the alert text field; applies to "Alert"
+ *
+ */
+
alertText3,
+ /** Long form body of text that can include newlines and tabs; applies to "ScrollableMessage"
+ *
+ */
+
scrollableMessageBody,
+ /** First line suggestion for a user response (in the case of VR enabled interaction)
+ *
+ */
+
initialInteractionText,
+ /** First line of navigation text
+ *
+ */
+
navigationText1,
+ /** Second line of navigation text
+ *
+ */
+
navigationText2,
+ /** Estimated Time of Arrival time for navigation
+ *
+ */
+
ETA,
+ /** Total distance to destination for navigation
+ *
+ */
+
totalDistance,
+ /** First line of text for audio pass thru
+ *
+ */
+
audioPassThruDisplayText1,
+ /** Second line of text for audio pass thru
+ *
+ */
+
audioPassThruDisplayText2,
+ /** Header text for slider
+ *
+ */
+
sliderHeader,
+ /** Footer text for slider
+ *
+ */
+
sliderFooter,
+ /** Primary text for Choice
+ *
+ */
+
menuName,
+ /** Secondary text for Choice
+ *
+ */
+
secondaryText,
+ /** Tertiary text for Choice
+ *
+ */
+
tertiaryText,
+ /** Optional text to label an app menu button (for certain touchscreen platforms).
+ *
+ */ menuTitle,
/**
* Optional name / title of intended location for SendLocation.
@@ -50,6 +150,11 @@ public enum TextFieldName { */
phoneNumber,
;
+ /**
+ * Convert String to TextFieldName
+ * @param value String
+ * @return TextFieldName
+ */
public static TextFieldName valueForString(String value) {
try{
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/TouchType.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/TouchType.java index 127139c13..952904915 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/TouchType.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/TouchType.java @@ -1,9 +1,31 @@ package com.smartdevicelink.proxy.rpc.enums;
+/** The type of touch event.
+ *
+ * @since SmartDeviceLink 2.3.2
+ *
+ */
public enum TouchType {
+ /** The user has touched the screen.
+ *
+ */
+
BEGIN,
+ /** The User has moved his finger over the screen.
+ *
+ */
+
MOVE,
+ /** The User has removed his finger from the screen.
+ *
+ */
+
END;
+ /**
+ * Convert String to TouchType
+ * @param value String
+ * @return TouchType
+ */
public static TouchType valueForString(String value) {
try{
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/UpdateMode.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/UpdateMode.java index 15c45b5f7..cd9bf6dfe 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/UpdateMode.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/UpdateMode.java @@ -2,7 +2,7 @@ package com.smartdevicelink.proxy.rpc.enums; /**
* Specifies what function should be performed on the media clock/counter
- * <p>
+ *
*
* @since SmartDeviceLink 1.0
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataNotificationStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataNotificationStatus.java index 1c132f26c..d7bca9fc7 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataNotificationStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataNotificationStatus.java @@ -3,11 +3,27 @@ package com.smartdevicelink.proxy.rpc.enums; /**
* Reflects the status of a vehicle data notification.
* @since SmartDeviceLink 2.0
+ *
+ * @see SoftButtonCapabilities
+ * @see ButtonCapabilities
+ * @see OnButtonPress
*/
public enum VehicleDataNotificationStatus {
+ /**
+ * VehicleDataNotificationStatus is not supported.
+ */
NOT_SUPPORTED,
+ /**
+ * VehicleDataNotificationStatus is normal.
+ */
NORMAL,
+ /**
+ * VehicleDataNotificationStatus is active.
+ */
ACTIVE,
+ /**
+ * VehicleDataNotificationStatus is not in use.
+ */
NOT_USED;
/**
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataResultCode.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataResultCode.java index 8de4ca88f..45c2e7c11 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataResultCode.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataResultCode.java @@ -1,19 +1,58 @@ package com.smartdevicelink.proxy.rpc.enums;
+/** Enumeration that describes possible result codes of a vehicle data entry request.
+ *
+ * @since SmartDeviceLink 2.0
+ *
+ *@see DIDResult
+ *@see ReadDID
+ */
public enum VehicleDataResultCode {
+ /**Individual vehicle data item / DTC / DID request or subscription successful
+ *
+ */
+
SUCCESS,
/**
*DTC / DID request successful, however, not all active DTCs or full contents of DID location available
*
* @since SmartDeviceLink 4.0
*/
+
TRUNCATED_DATA,
+ /** This vehicle data item is not allowed for this app .The request is not authorized in local policies.
+ *
+ */
+
DISALLOWED,
+ /** The user has not granted access to this type of vehicle data item at this time.
+ *
+ */
+
USER_DISALLOWED,
+ /** The ECU ID referenced is not a valid ID on the bus / system.
+ *
+ */
+
INVALID_ID,
+ /** The requested vehicle data item / DTC / DID is not currently available or responding on the bus / system.
+ *
+ */
+
VEHICLE_DATA_NOT_AVAILABLE,
+ /** The vehicle data item is already subscribed.
+ *
+ */
+
DATA_ALREADY_SUBSCRIBED,
+ /** The vehicle data item cannot be unsubscribed because it is not currently subscribed.
+ *
+ */
+
DATA_NOT_SUBSCRIBED,
+ /** The request for this item is ignored because it is already in progress
+ */
+
IGNORED;
public static VehicleDataResultCode valueForString(String value) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataStatus.java index b944c0eed..2245bbe71 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataStatus.java @@ -10,7 +10,15 @@ public enum VehicleDataStatus { * No data available
*/
NO_DATA_EXISTS,
+ /**
+ * The vehicle item is in Off state
+ */
+
OFF,
+ /**
+ * The vehicle item is in On state
+ */
+
ON;
/**
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataType.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataType.java index fe777e707..adebca268 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataType.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataType.java @@ -1,36 +1,119 @@ package com.smartdevicelink.proxy.rpc.enums;
/**
- * Defines the vehicle data types that can be published and subscribed to
+ * Defines the vehicle data types that can be published and subscribed to.
*
*/
public enum VehicleDataType {
+ /**
+ * Notifies GPSData may be subscribed
+ */
VEHICLEDATA_GPS,
+ /**
+ * Notifies SPEED Data may be subscribed
+ */
VEHICLEDATA_SPEED,
+ /**
+ * Notifies RPMData may be subscribed
+ */
VEHICLEDATA_RPM,
+ /**
+ * Notifies FUELLEVELData may be subscribed
+ */
VEHICLEDATA_FUELLEVEL,
+ /**
+ * Notifies FUELLEVEL_STATEData may be subscribed
+ */
VEHICLEDATA_FUELLEVEL_STATE,
+/**
+ * Notifies FUELCONSUMPTIONData may be subscribed
+ */
VEHICLEDATA_FUELCONSUMPTION,
+ /**
+ * Notifies EXTERNTEMPData may be subscribed
+ */
VEHICLEDATA_EXTERNTEMP,
+ /**
+ * Notifies VINData may be subscribed
+ */
VEHICLEDATA_VIN,
+ /**
+ * Notifies PRNDLData may be subscribed
+ */
VEHICLEDATA_PRNDL,
+ /**
+ * Notifies TIREPRESSUREData may be subscribed
+ */
VEHICLEDATA_TIREPRESSURE,
- VEHICLEDATA_ODOMETER,
+ /**
+ * Notifies ODOMETERData may be subscribed
+ */
+ VEHICLEDATA_ODOMETER,
+ /**
+ * Notifies BELTSTATUSData may be subscribed
+ */
VEHICLEDATA_BELTSTATUS,
+ /**
+ * Notifies BODYINFOData may be subscribed
+ */
VEHICLEDATA_BODYINFO,
+ /**
+ * Notifies DEVICESTATUSData may be subscribed
+ */
VEHICLEDATA_DEVICESTATUS,
+ /**
+ * Notifies BRAKINGData may be subscribed
+ */
VEHICLEDATA_BRAKING,
+ /**
+ * Notifies WIPERSTATUSData may be subscribed
+ */
VEHICLEDATA_WIPERSTATUS,
+ /**
+ * Notifies HEADLAMPSTATUSData may be subscribed
+ */
VEHICLEDATA_HEADLAMPSTATUS,
+ /**
+ * Notifies BATTVOLTAGEData may be subscribed
+ */
VEHICLEDATA_BATTVOLTAGE,
+ /**
+ * Notifies EGINETORQUEData may be subscribed
+ */
VEHICLEDATA_ENGINETORQUE,
+ /**
+ * Notifies ACCPEDALData may be subscribed
+ */
VEHICLEDATA_ACCPEDAL,
+ /**
+ * Notifies STEERINGWHEELData may be subscribed
+ */
VEHICLEDATA_STEERINGWHEEL,
+ /**
+ * Notifies ECALLINFOData may be subscribed
+ */
VEHICLEDATA_ECALLINFO,
+ /**
+ * Notifies AIRBAGSTATUSData may be subscribed
+ */
VEHICLEDATA_AIRBAGSTATUS,
+ /**
+ * Notifies EMERGENCYEVENTData may be subscribed
+ */
VEHICLEDATA_EMERGENCYEVENT,
+ /**
+ * Notifies CLUSTERMODESTATUSData may be subscribed
+ */
VEHICLEDATA_CLUSTERMODESTATUS,
+ /**
+ * Notifies MYKEYData may be subscribed
+ */
VEHICLEDATA_MYKEY;
+ /**
+ * Convert String to VehicleDataType
+ * @param value String
+ * @return VehicleDataType
+ */
public static VehicleDataType valueForString(String value) {
try{
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/WiperStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/WiperStatus.java index 3c67ddfca..546cf05b5 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/WiperStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/WiperStatus.java @@ -1,21 +1,92 @@ package com.smartdevicelink.proxy.rpc.enums;
+/** This enumeration reflects the status of the wipers.
+ *
+ * @since SmartDeviceLink 2.0
+ *
+ * @see GetVehicleData
+ * @see OnVehicleData
+ */
public enum WiperStatus {
+ /** The wipers are off.
+ *
+ */
+
OFF,
+ /** The wipers are automatically off after detecting the wipers do not need to be engaged (rain stopped, etc.).
+ *
+ */
+
AUTO_OFF,
+ /** Means that though set to off, somehow the wipers have been engaged (physically moved enough to engage a wiping motion).
+ *
+ */
+
OFF_MOVING,
+ /** The wipers are manually off after having been working.
+ *
+ */
+
MAN_INT_OFF,
+ /** The wipers are manually on.
+ *
+ */
+
MAN_INT_ON,
+ /** The wipers are manually set to low speed.
+ *
+ */
+
MAN_LOW,
+ /** The wipers are manually set to high speed.
+ *
+ */
+
MAN_HIGH,
+ /** The wipers are manually set for doing a flick.
+ *
+ */
+
MAN_FLICK,
+ /** The wipers are set to use the water from vehicle washer bottle for cleaning the windscreen.
+ *
+ */
+
WASH,
+ /** The wipers are automatically set to low speed.
+ *
+ */
+
AUTO_LOW,
+ /** The wipers are automatically set to high speed.
+ *
+ */
+
AUTO_HIGH,
+ /** This is for when a user has just initiated a WASH and several seconds later a secondary wipe is automatically initiated to clear remaining fluid
+ */
+
COURTESYWIPE,
+ /** This is set as the user moves between possible automatic wiper speeds.
+ *
+ */
+
AUTO_ADJUST,
+ /** The wiper is stalled to its place. There may be an obstruction.
+ *
+ */
+
STALLED,
+ /** The sensor / module cannot provide any information for wiper.
+ *
+ */
+
NO_DATA_EXISTS;
+ /**
+ * Convert String to WiperStatus
+ * @param value String
+ * @return WiperStatus
+ */
public static WiperStatus valueForString(String value) {
try{
diff --git a/sdl_android_lib/src/com/smartdevicelink/transport/BTTransport.java b/sdl_android_lib/src/com/smartdevicelink/transport/BTTransport.java index e41c501e5..f64ff3668 100644 --- a/sdl_android_lib/src/com/smartdevicelink/transport/BTTransport.java +++ b/sdl_android_lib/src/com/smartdevicelink/transport/BTTransport.java @@ -187,7 +187,7 @@ public class BTTransport extends SdlTransport { throw new SdlException("Bluetooth adapter must be on to instantiate a SdlProxy object.", SdlExceptionCause.BLUETOOTH_DISABLED);
}
- if(((SdlException) ex).getSdlExceptionCause() == SdlExceptionCause.BLUETOOTH_SOCKET_UNAVAILABLE) {
+ if(ex instanceof SdlException && ((SdlException) ex).getSdlExceptionCause() == SdlExceptionCause.BLUETOOTH_SOCKET_UNAVAILABLE) {
SdlConnection.enableLegacyMode(false, null);
throw new SdlException("Could not open connection to SDL.", SdlExceptionCause.BLUETOOTH_SOCKET_UNAVAILABLE);
diff --git a/sdl_android_lib/src/com/smartdevicelink/transport/MultiplexTransport.java b/sdl_android_lib/src/com/smartdevicelink/transport/MultiplexTransport.java index 5556d9af1..e82bcd209 100644 --- a/sdl_android_lib/src/com/smartdevicelink/transport/MultiplexTransport.java +++ b/sdl_android_lib/src/com/smartdevicelink/transport/MultiplexTransport.java @@ -33,16 +33,6 @@ public class MultiplexTransport extends SdlTransport{ //brokerThread.start(); } - - public boolean forceHardwareConnectEvent(TransportType type){ - if(brokerThread!=null){ - brokerThread.onHardwareConnected(type); - return true; - } - Log.w(TAG, "Transport broker thread was null, nothing to force connect. Are we disconnecting? " + isDisconnecting); - return false; - - } public boolean isDisconnecting(){ return this.isDisconnecting; diff --git a/sdl_android_lib/src/com/smartdevicelink/transport/SdlBroadcastReceiver.java b/sdl_android_lib/src/com/smartdevicelink/transport/SdlBroadcastReceiver.java index 70589bc4a..1686285c9 100644 --- a/sdl_android_lib/src/com/smartdevicelink/transport/SdlBroadcastReceiver.java +++ b/sdl_android_lib/src/com/smartdevicelink/transport/SdlBroadcastReceiver.java @@ -176,7 +176,7 @@ public abstract class SdlBroadcastReceiver extends BroadcastReceiver{ return false; } Log.d(TAG, "Looking for Service: "+ SDL_ROUTER_SERVICE_CLASS_NAME); - ActivityManager manager = (ActivityManager) context.getSystemService("activity"); + ActivityManager manager = (ActivityManager) context.getSystemService(Context.ACTIVITY_SERVICE); for (RunningServiceInfo service : manager.getRunningServices(Integer.MAX_VALUE)) { //We will check to see if it contains this name, should be pretty specific //Log.d(TAG, "Found Service: "+ service.service.getClassName()); @@ -198,29 +198,19 @@ public abstract class SdlBroadcastReceiver extends BroadcastReceiver{ /** * If a Router Service is running, this method determines if that service is connected to a device over some form of transport. - * @param context A context to access Android system services through. - * @return True if a transport connection is established, false otherwise. + * @param context A context to access Android system services through. If null is passed, this will always return false + * @param callback Use this callback to find out if the router service is connected or not. */ - public static boolean isTransportConnected(Context context){ + public static void requestTransportStatus(Context context, SdlRouterStatusProvider.ConnectedStatusCallback callback){ Log.d(TAG, "Checking to see if router service is transport connected"); - if(isRouterServiceRunning(context,false)){ //So there is a service up, let's see if it's connected - Context con; - try { - con = context.createPackageContext(runningBluetoothServicePackage.getPackageName(), 0); - if(con==null ){ - Log.w(TAG, "Unable to check for service connection. Returning false. "+runningBluetoothServicePackage); - return false; // =( well that sucks. - } - SharedPreferences pref = con.getSharedPreferences( - con.getPackageName()+TRANSPORT_GLOBAL_PREFS , 4); - boolean connected = pref.getBoolean(IS_TRANSPORT_CONNECTED, false); - // Log.w(TAG, "Is Connected? Returning " + connected); - return connected; - } catch (NameNotFoundException e) { - e.printStackTrace(); - return false; + if(context == null){ + if(callback!=null){ + callback.onConnectionStatusUpdate(false, context); } - + } + if(isRouterServiceRunning(context,false)){ //So there is a service up, let's see if it's connected + SdlRouterStatusProvider provider = new SdlRouterStatusProvider(context,runningBluetoothServicePackage,callback); + provider.checkIsConnected(); }else{ Log.w(TAG, "Router service isn't running, returning false."); if(BluetoothAdapter.getDefaultAdapter()!=null && BluetoothAdapter.getDefaultAdapter().isEnabled()){ @@ -229,9 +219,10 @@ public abstract class SdlBroadcastReceiver extends BroadcastReceiver{ serviceIntent.putExtra(TransportConstants.PING_ROUTER_SERVICE_EXTRA, true); context.sendBroadcast(serviceIntent); } + if(callback!=null){ + callback.onConnectionStatusUpdate(false, context); + } } - - return false; } @@ -244,13 +235,12 @@ public abstract class SdlBroadcastReceiver extends BroadcastReceiver{ } /** - * We need to define this for local copy of the Sdl Bluetooth Service class. - * It will be the main point of connection for Sdl Connected apps + * We need to define this for local copy of the Sdl Router Service class. + * It will be the main point of connection for Sdl enabled apps * @return Return the local copy of SdlRouterService.class * {@inheritDoc} */ - @SuppressWarnings("rawtypes") - public abstract Class defineLocalSdlRouterClass(); + public abstract Class<? extends SdlRouterService> defineLocalSdlRouterClass(); diff --git a/sdl_android_lib/src/com/smartdevicelink/transport/SdlRouterService.java b/sdl_android_lib/src/com/smartdevicelink/transport/SdlRouterService.java index 1bb7f3d72..ffca24c18 100644 --- a/sdl_android_lib/src/com/smartdevicelink/transport/SdlRouterService.java +++ b/sdl_android_lib/src/com/smartdevicelink/transport/SdlRouterService.java @@ -102,7 +102,8 @@ public class SdlRouterService extends Service{ private static boolean connectAsClient = false; private static boolean closing = false; - private boolean isTarnsportConnected = false; + private boolean isTransportConnected = false; + private TransportType connectedTransportType = null; private static Context currentContext = null; private Handler versionCheckTimeOutHandler, altTransportTimerHandler; @@ -318,9 +319,10 @@ public class SdlRouterService extends Service{ pingClients(); Message message = Message.obtain(); message.what = TransportConstants.ROUTER_REGISTER_CLIENT_RESPONSE; + message.arg1 = TransportConstants.REGISTRATION_RESPONSE_SUCESS; long appId = receivedBundle.getLong(TransportConstants.APP_ID_EXTRA, -1); if(appId<0 || msg.replyTo == null){ - Log.w(TAG, "Unable to requster app as no id or messenger was included"); + Log.w(TAG, "Unable to register app as no id or messenger was included"); if(msg.replyTo!=null){ message.arg1 = TransportConstants.REGISTRATION_RESPONSE_DENIED_APP_ID_NOT_INCLUDED; try { @@ -354,22 +356,26 @@ public class SdlRouterService extends Service{ } } onAppRegistered(app); - + returnBundle = new Bundle(); - - if(MultiplexBluetoothTransport.currentlyConnectedDevice!=null){ - returnBundle.putString(CONNECTED_DEVICE_STRING_EXTRA_NAME, MultiplexBluetoothTransport.currentlyConnectedDevice); - } - if(!returnBundle.isEmpty()){ - message.setData(returnBundle); + //Add params if connected + if(SdlRouterService.this.isTransportConnected){ + returnBundle.putString(TransportConstants.HARDWARE_CONNECTED, SdlRouterService.this.connectedTransportType.name()); + if(MultiplexBluetoothTransport.currentlyConnectedDevice!=null){ + returnBundle.putString(CONNECTED_DEVICE_STRING_EXTRA_NAME, MultiplexBluetoothTransport.currentlyConnectedDevice); + } } + //Add the version of this router service + returnBundle.putInt(TransportConstants.ROUTER_SERVICE_VERSION, SdlRouterService.ROUTER_SERVICE_VERSION_NUMBER); + + message.setData(returnBundle); + int result = app.sendMessage(message); if(result == RegisteredApp.SEND_MESSAGE_ERROR_MESSENGER_DEAD_OBJECT){ synchronized(REGISTERED_APPS_LOCK){ registeredApps.remove(appId); } } - break; case TransportConstants.ROUTER_UNREGISTER_CLIENT: long appIdToUnregister = receivedBundle.getLong(TransportConstants.APP_ID_EXTRA, -1); @@ -518,7 +524,6 @@ public class SdlRouterService extends Service{ && altTransportService.equals(msg.replyTo)){ //The same transport that was connected to the router service is now telling us it's disconnected. Let's inform clients and clear our saved messenger altTransportService = null; - storeConnectedStatus(false); onTransportDisconnected(TransportType.valueOf(receivedBundle.getString(TransportConstants.HARDWARE_DISCONNECTED))); shouldServiceRemainOpen(null); //this will close the service if bluetooth is not available } @@ -538,7 +543,6 @@ public class SdlRouterService extends Service{ altTransportTimerHandler = null; altTransportTimerRunnable = null; - storeConnectedStatus(true); //Let the alt transport know they are good to go retMsg.arg1 = TransportConstants.ROUTER_REGISTER_ALT_TRANSPORT_RESPONSE_SUCESS; onTransportConnected(TransportType.valueOf(receivedBundle.getString(TransportConstants.HARDWARE_CONNECTED))); @@ -574,6 +578,39 @@ public class SdlRouterService extends Service{ } }; + + /** + * Target we publish for alternative transport (USB) clients to send messages to RouterHandler. + */ + final Messenger routerStatusMessenger = new Messenger(new RouterStatusHandler()); + + /** + * Handler of incoming messages from an alternative transport (USB). + */ + class RouterStatusHandler extends Handler { + ClassLoader loader = getClass().getClassLoader(); + @Override + public void handleMessage(Message msg) { + switch(msg.what){ + case TransportConstants.ROUTER_STATUS_CONNECTED_STATE_REQUEST: + if(msg.replyTo==null){ + break; + } + Message message = Message.obtain(); + message.what = TransportConstants.ROUTER_STATUS_CONNECTED_STATE_RESPONSE; + message.arg1 = (isTransportConnected == true) ? 1 : 0; + try { + msg.replyTo.send(message); + } catch (RemoteException e) { + e.printStackTrace(); + } + break; + default: + Log.w(TAG, "Unsopported request: " + msg.what); + break; + } + } + }; /* ************************************************************************************************************************************** *********************************************** Life Cycle ************************************************************** @@ -592,6 +629,8 @@ public class SdlRouterService extends Service{ return this.altTransportMessenger.getBinder(); }else if(TransportConstants.BIND_REQUEST_TYPE_CLIENT.equals(requestType)){ return this.routerMessenger.getBinder(); + }else if(TransportConstants.BIND_REQUEST_TYPE_STATUS.equals(requestType)){ + return this.routerStatusMessenger.getBinder(); }else{ Log.w(TAG, "Uknown bind request type"); } @@ -689,7 +728,6 @@ public class SdlRouterService extends Service{ } closing = false; currentContext = getBaseContext(); - storeConnectedStatus(false); startVersionCheck(); Log.i(TAG, "SDL Router Service has been created"); @@ -945,7 +983,6 @@ public class SdlRouterService extends Service{ */ public void closeSelf(){ closing = true; - storeConnectedStatus(false); if(getBaseContext()!=null){ stopSelf(); }else{ @@ -978,7 +1015,7 @@ public class SdlRouterService extends Service{ } public void onTransportConnected(final TransportType type){ - isTarnsportConnected = true; + isTransportConnected = true; enterForeground(); if(packetWriteTaskMaster!=null){ packetWriteTaskMaster.close(); @@ -987,6 +1024,8 @@ public class SdlRouterService extends Service{ packetWriteTaskMaster = new PacketWriteTaskMaster(); packetWriteTaskMaster.start(); + connectedTransportType = type; + Intent startService = new Intent(); startService.setAction(START_SERVICE_ACTION); startService.putExtra(TransportConstants.START_ROUTER_SERVICE_SDL_ENABLED_EXTRA, true); @@ -995,6 +1034,23 @@ public class SdlRouterService extends Service{ startService.putExtra(TransportConstants.START_ROUTER_SERVICE_SDL_ENABLED_CMP_NAME, new ComponentName(this, this.getClass())); sendBroadcast(startService); //HARDWARE_CONNECTED + if(!(registeredApps== null || registeredApps.isEmpty())){ + //If we have clients + notifyClients(createHardwareConnectedMessage(type)); + } + } + + private Message createHardwareConnectedMessage(final TransportType type){ + Message message = Message.obtain(); + message.what = TransportConstants.HARDWARE_CONNECTION_EVENT; + Bundle bundle = new Bundle(); + bundle.putString(TransportConstants.HARDWARE_CONNECTED, type.name()); + if(MultiplexBluetoothTransport.currentlyConnectedDevice!=null){ + bundle.putString(CONNECTED_DEVICE_STRING_EXTRA_NAME, MultiplexBluetoothTransport.currentlyConnectedDevice); + } + message.setData(bundle); + return message; + } public void onTransportDisconnected(TransportType type){ @@ -1002,8 +1058,8 @@ public class SdlRouterService extends Service{ return; } Log.e(TAG, "Notifying client service of hardware disconnect."); - - isTarnsportConnected = false; + connectedTransportType = null; + isTransportConnected = false; stopClientPings(); exitForeground();//Leave our foreground state as we don't have a connection anymore @@ -1074,20 +1130,17 @@ public class SdlRouterService extends Service{ case MESSAGE_STATE_CHANGE: switch (msg.arg1) { case MultiplexBluetoothTransport.STATE_CONNECTED: - storeConnectedStatus(true); onTransportConnected(TransportType.BLUETOOTH); break; case MultiplexBluetoothTransport.STATE_CONNECTING: // Currently attempting to connect - update UI? break; case MultiplexBluetoothTransport.STATE_LISTEN: - storeConnectedStatus(false); break; case MultiplexBluetoothTransport.STATE_NONE: // We've just lost the connection - storeConnectedStatus(false); - if(!connectAsClient && !closing){ - if(!legacyModeEnabled){ + if(!connectAsClient ){ + if(!legacyModeEnabled && !closing){ initBluetoothSerialService(); } onTransportDisconnected(TransportType.BLUETOOTH); @@ -1423,17 +1476,6 @@ public class SdlRouterService extends Service{ //************************************************************************************************************************************** //********************************************************* PREFERENCES **************************************************************** //************************************************************************************************************************************** - - @SuppressLint("WorldReadableFiles") - @SuppressWarnings("deprecation") - private void storeConnectedStatus(boolean isConnected){ - SharedPreferences prefs = getApplicationContext().getSharedPreferences(getApplicationContext().getPackageName()+SdlBroadcastReceiver.TRANSPORT_GLOBAL_PREFS, - Context.MODE_WORLD_READABLE); - SharedPreferences.Editor editor = prefs.edit(); - editor.putBoolean(SdlBroadcastReceiver.IS_TRANSPORT_CONNECTED, isConnected); - editor.commit(); - } - /** * This method will set the last known bluetooth connection method that worked with this phone. * This helps speed up the process of connecting @@ -1774,7 +1816,7 @@ public class SdlRouterService extends Service{ private void startClientPings(){ synchronized(this){ - if(!isTarnsportConnected){ //If we aren't connected, bail + if(!isTransportConnected){ //If we aren't connected, bail return; } if(isPingingClients){ diff --git a/sdl_android_lib/src/com/smartdevicelink/transport/SdlRouterStatusProvider.java b/sdl_android_lib/src/com/smartdevicelink/transport/SdlRouterStatusProvider.java new file mode 100644 index 000000000..f36dcb2c0 --- /dev/null +++ b/sdl_android_lib/src/com/smartdevicelink/transport/SdlRouterStatusProvider.java @@ -0,0 +1,137 @@ +package com.smartdevicelink.transport; + +import java.lang.ref.WeakReference; + +import android.annotation.SuppressLint; +import android.content.ComponentName; +import android.content.Context; +import android.content.Intent; +import android.content.ServiceConnection; +import android.os.Handler; +import android.os.IBinder; +import android.os.Message; +import android.os.Messenger; +import android.os.RemoteException; +import android.util.Log; + +public class SdlRouterStatusProvider { + + private static final String TAG = "SdlRouterStateProvider"; + + private Context context = null; + private boolean isBound = false; + ConnectedStatusCallback cb = null; + Messenger routerServiceMessenger = null; + private ComponentName routerService = null; + + final Messenger clientMessenger; + + private ServiceConnection routerConnection= new ServiceConnection() { + + public void onServiceConnected(ComponentName className, IBinder service) { + Log.d(TAG, "Bound to service " + className.toString()); + routerServiceMessenger = new Messenger(service); + isBound = true; + //So we just established our connection + //Register with router service + Message msg = Message.obtain(); + msg.what = TransportConstants.ROUTER_STATUS_CONNECTED_STATE_REQUEST; + msg.replyTo = clientMessenger; + try { + routerServiceMessenger.send(msg); + } catch (RemoteException e) { + e.printStackTrace(); + if(cb!=null){ + cb.onConnectionStatusUpdate(false, context); + } + } + } + + public void onServiceDisconnected(ComponentName className) { + Log.d(TAG, "UN-Bound from service " + className.getClassName()); + routerServiceMessenger = null; + isBound = false; + } + }; + + public SdlRouterStatusProvider(Context context, ComponentName service, ConnectedStatusCallback callback){ + if(context == null || service == null || callback == null){ + throw new IllegalStateException("Supplied params are not correct. Context == null? "+ (context==null) + " ComponentName == null? " + (service == null) + " ConnectedStatusListener == null? " + callback); + } + this.context = context; + this.routerService = service; + this.cb = callback; + this.clientMessenger = new Messenger(new ClientHandler(this)); + + } + + public void checkIsConnected(){ + if(!bindToService()){ + //We are unable to bind to service + cb.onConnectionStatusUpdate(false, context); + } + } + + public void cancel(){ + if(isBound){ + unBindFromService(); + } + } + + private boolean bindToService(){ + if(isBound){ + return true; + } + Intent bindingIntent = new Intent(); + bindingIntent.setClassName(this.routerService.getPackageName(), this.routerService.getClassName());//This sets an explicit intent + //Quickly make sure it's just up and running + context.startService(bindingIntent); + bindingIntent.setAction( TransportConstants.BIND_REQUEST_TYPE_STATUS); + return context.bindService(bindingIntent, routerConnection, Context.BIND_AUTO_CREATE); + } + + private void unBindFromService(){ + try{ + if(context!=null && routerConnection!=null){ + context.unbindService(routerConnection); + }else{ + Log.w(TAG, "Unable to unbind from router service, context was null"); + } + + }catch(IllegalArgumentException e){ + //This is ok + } + } + + private void handleRouterStatusConnectedResponse(int connectedStatus){ + if(cb!=null){ + cb.onConnectionStatusUpdate(connectedStatus == 1, context); + } + unBindFromService(); + routerServiceMessenger =null; + } + + static class ClientHandler extends Handler { + WeakReference<SdlRouterStatusProvider> provider; + + public ClientHandler(SdlRouterStatusProvider provider){ + this.provider = new WeakReference<SdlRouterStatusProvider>(provider); + } + + @Override + public void handleMessage(Message msg) { + switch (msg.what) { + case TransportConstants.ROUTER_STATUS_CONNECTED_STATE_RESPONSE: + provider.get().handleRouterStatusConnectedResponse(msg.arg1); + break; + default: + break; + } + } + }; + + public interface ConnectedStatusCallback{ + public void onConnectionStatusUpdate(boolean connected, Context context); + } + +} diff --git a/sdl_android_lib/src/com/smartdevicelink/transport/TransportBroker.java b/sdl_android_lib/src/com/smartdevicelink/transport/TransportBroker.java index 613c857d9..493612ea3 100644 --- a/sdl_android_lib/src/com/smartdevicelink/transport/TransportBroker.java +++ b/sdl_android_lib/src/com/smartdevicelink/transport/TransportBroker.java @@ -154,15 +154,17 @@ public class TransportBroker { case TransportConstants.REGISTRATION_RESPONSE_SUCESS: // yay! we have been registered. Now what? registeredWithRouterService = true; - if(bundle!=null && bundle.containsKey(TransportConstants.CONNECTED_DEVICE_STRING_EXTRA_NAME)){ - //Keep track if we actually get this - } - if(queuedOnTransportConnect!=null){ - onHardwareConnected(queuedOnTransportConnect); - queuedOnTransportConnect = null; - }else if(SdlBroadcastReceiver.isTransportConnected(getContext())){ - onHardwareConnected(null); //FIXME to include type - } + if(bundle !=null){ + if(bundle.containsKey(TransportConstants.HARDWARE_CONNECTED)){ + if(bundle.containsKey(TransportConstants.CONNECTED_DEVICE_STRING_EXTRA_NAME)){ + //Keep track if we actually get this + } + onHardwareConnected(TransportType.valueOf(bundle.getString(TransportConstants.HARDWARE_CONNECTED))); + } + /*if(bundle.containsKey(TransportConstants.ROUTER_SERVICE_VERSION)){ + //Keep track if we actually get this + }*/ + } break; case TransportConstants.REGISTRATION_RESPONSE_DENIED_LEGACY_MODE_ENABLED: Log.d(TAG, "Denied registration because router is in legacy mode" ); @@ -252,6 +254,9 @@ public class TransportBroker { } if(bundle.containsKey(TransportConstants.HARDWARE_CONNECTED)){ + if(bundle!=null && bundle.containsKey(TransportConstants.CONNECTED_DEVICE_STRING_EXTRA_NAME)){ + //Keep track if we actually get this + } onHardwareConnected(TransportType.valueOf(bundle.getString(TransportConstants.HARDWARE_CONNECTED))); break; } @@ -397,7 +402,7 @@ public class TransportBroker { return false; } - ActivityManager manager = (ActivityManager) context.getSystemService("activity"); + ActivityManager manager = (ActivityManager) context.getSystemService(Context.ACTIVITY_SERVICE); for (RunningServiceInfo service : manager.getRunningServices(Integer.MAX_VALUE)) { //We will check to see if it contains this name, should be pretty specific if ((service.service.getClassName()).toLowerCase(Locale.US).contains(SdlBroadcastReceiver.SDL_ROUTER_SERVICE_CLASS_NAME)) { diff --git a/sdl_android_lib/src/com/smartdevicelink/transport/TransportConstants.java b/sdl_android_lib/src/com/smartdevicelink/transport/TransportConstants.java index 00b7e54b0..ac9b9b6c6 100644 --- a/sdl_android_lib/src/com/smartdevicelink/transport/TransportConstants.java +++ b/sdl_android_lib/src/com/smartdevicelink/transport/TransportConstants.java @@ -53,6 +53,7 @@ public class TransportConstants { public static final String BIND_REQUEST_TYPE_CLIENT = "BIND_REQUEST_TYPE_CLIENT"; public static final String BIND_REQUEST_TYPE_ALT_TRANSPORT = "BIND_REQUEST_TYPE_ALT_TRANSPORT"; + public static final String BIND_REQUEST_TYPE_STATUS = "BIND_REQUEST_TYPE_STATUS"; public static final String PING_ROUTER_SERVICE_EXTRA = "ping.router.service"; @@ -189,7 +190,15 @@ public class TransportConstants { public static final int PACKET_SENDING_ERROR_NOT_CONNECTED = 0x01; public static final int PACKET_SENDING_ERROR_UKNOWN = 0xFF; + public static final String ROUTER_SERVICE_VERSION = "router_service_version"; + + /** + * Status binder + */ + public static final int ROUTER_STATUS_CONNECTED_STATE_REQUEST = 0x01; + public static final int ROUTER_STATUS_CONNECTED_STATE_RESPONSE = 0x02; + |
