summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBilal Alsharifi <bilal.alsharifi@gmail.com>2019-07-19 15:52:07 -0400
committerBilal Alsharifi <bilal.alsharifi@gmail.com>2019-07-19 15:52:07 -0400
commit681399862aa706c614e9e7bc2a4fe8f9d18c4c64 (patch)
treeec1e50d7dcbc7437a399c392f6dcbb2bfcc6e9b6
parentdc7b4189351ca4b024bd086a13e67aa3eff09947 (diff)
downloadsdl_android-681399862aa706c614e9e7bc2a4fe8f9d18c4c64.tar.gz
Update javadoc to address review commentsfeature/issue_649
-rw-r--r--base/src/main/java/com/smartdevicelink/managers/screen/choiceset/KeyboardAutocompleteCompletionListener.java4
-rw-r--r--base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java15
2 files changed, 16 insertions, 3 deletions
diff --git a/base/src/main/java/com/smartdevicelink/managers/screen/choiceset/KeyboardAutocompleteCompletionListener.java b/base/src/main/java/com/smartdevicelink/managers/screen/choiceset/KeyboardAutocompleteCompletionListener.java
index 2a67b36a3..992509019 100644
--- a/base/src/main/java/com/smartdevicelink/managers/screen/choiceset/KeyboardAutocompleteCompletionListener.java
+++ b/base/src/main/java/com/smartdevicelink/managers/screen/choiceset/KeyboardAutocompleteCompletionListener.java
@@ -32,6 +32,9 @@
package com.smartdevicelink.managers.screen.choiceset;
+import com.smartdevicelink.proxy.SystemCapabilityManager;
+import com.smartdevicelink.proxy.rpc.enums.SystemCapabilityType;
+
import java.util.List;
public interface KeyboardAutocompleteCompletionListener {
@@ -39,6 +42,7 @@ public interface KeyboardAutocompleteCompletionListener {
/**
* This listener is called when you wish to update your autocomplete text in response to the user's input
* @param updatedAutoCompleteText - The new autocomplete text to use
+ * @deprecated use {@link #onUpdatedAutoCompleteList(List<String>)} instead
*/
@Deprecated
void onUpdatedAutoCompleteText(String updatedAutoCompleteText);
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java
index 4b8e46fd3..cd721fec8 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java
@@ -98,7 +98,7 @@ import java.util.List;
* <td>String</td>
* <td>false</td>
* <td>Array = true maxlength = 1000 minsize = 0 maxsize = 100</td>
- * <td>Allows an app to prepopulate the text field with a list of suggested or completed entry as the user types. Set to 0 to remove the auto-complete list from the screen</td>
+ * <td>Allows an app to prepopulate the text field with a list of suggested or completed entry as the user types. Set to an empty array to remove the auto-complete list from the screen</td>
* </tr>
* </table>
*
@@ -168,12 +168,21 @@ public class KeyboardProperties extends RPCStruct {
setValue(KEY_LIMITED_CHARACTER_LIST, limitedCharacterList);
}
+ /**
+ * Gets the text that allows an app to prepopulate the text field with a suggested entry as the user types
+ * @return String representing the suggestions text
+ */
@Deprecated
public String getAutoCompleteText() {
return (String) getObject(String.class, KEY_AUTO_COMPLETE_TEXT);
}
- @Deprecated // Note: removing autoCompleteText will leave no way to provide auto complete suggestions on old head units that don't support autoCompleteList
+ /**
+ * Sets the text that allows an app to prepopulate the text field with a suggested entry as the user types
+ * @param autoCompleteText String representing the suggestions text
+ * @deprecated use {@link #setAutoCompleteList(List<String>)} instead
+ */
+ @Deprecated // Note: removing autoCompleteText setter will leave no way to provide auto complete suggestions on old head units that don't support autoCompleteList
public void setAutoCompleteText(String autoCompleteText) {
setValue(KEY_AUTO_COMPLETE_TEXT, autoCompleteText);
}
@@ -189,7 +198,7 @@ public class KeyboardProperties extends RPCStruct {
/**
* Sets the lists that allows an app to prepopulate the text field with a list of suggested or
- * completed entries as the user types. Set to 0 to remove the auto-complete list from the screen
+ * completed entries as the user types. Set to an empty array to remove the auto-complete list from the screen
* @param autoCompleteList List<String> representing the suggestions list
*/
public void setAutoCompleteList(List<String> autoCompleteList) {