diff options
| author | Robert Henigan <robert.henigan@livio.io> | 2021-01-22 17:17:53 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-22 17:17:53 -0500 |
| commit | 3c4c4048def6e6418cec7cd3d4bf42f305d1fc2c (patch) | |
| tree | c2ecd5773297d7c8f9e916c573514dbeba7783c8 | |
| parent | 48b2192954a95f816736304d28159a8972b3fe2f (diff) | |
| parent | cdccba17d493cc97e7a31c0fcba3585f93981766 (diff) | |
| download | sdl_android-3c4c4048def6e6418cec7cd3d4bf42f305d1fc2c.tar.gz | |
Merge pull request #1607 from smartdevicelink/deprecate-MediaClock-in-Show
Deprecate mediaClock
| -rw-r--r-- | base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java | 41 | ||||
| -rw-r--r-- | base/src/main/java/com/smartdevicelink/proxy/rpc/enums/TextFieldName.java | 5 |
2 files changed, 28 insertions, 18 deletions
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java index e11ac0009..1263a47e6 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java @@ -117,10 +117,13 @@ import java.util.List; * <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>Text value for MediaClock field. Has to be properly formatted by Mobile App according to the module's capabilities. 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>
+ * <td>{"string_min_length": 0, "string_max_length": 500}</td>
+ * <td>
+ * @since SmartDeviceLink 1.0.0
+ * @deprecated in SmartDeviceLink 7.1.0
+ * </td>
* </tr>
* <tr>
* <td>mediaTrack</td>
@@ -198,6 +201,10 @@ public class Show extends RPCRequest { public static final String KEY_MAIN_FIELD_3 = "mainField3";
public static final String KEY_MAIN_FIELD_4 = "mainField4";
public static final String KEY_STATUS_BAR = "statusBar";
+ /**
+ * @since SmartDeviceLink 1.0.0
+ * @deprecated in SmartDeviceLink 7.1.0
+ */
@Deprecated
public static final String KEY_MEDIA_CLOCK = "mediaClock";
public static final String KEY_ALIGNMENT = "alignment";
@@ -421,9 +428,14 @@ public class Show extends RPCRequest { }
/**
- * Gets the String value of the MediaClock
+ * Gets the mediaClock.
*
- * @return String -a String value of the MediaClock
+ * @return String Text value for MediaClock field. Has to be properly formatted by Mobile App according to
+ * the module's capabilities. If this text is set, any automatic media clock updates
+ * previously set with SetMediaClockTimer will be stopped.
+ * {"string_min_length": 0, "string_max_length": 500}
+ * @since SmartDeviceLink 1.0.0
+ * @deprecated in SmartDeviceLink 7.1.0
*/
@Deprecated
public String getMediaClock() {
@@ -431,19 +443,14 @@ public class Show extends RPCRequest { }
/**
- * Sets the value for the MediaClock field using a format described in the
- * MediaClockFormat enumeration
+ * Sets the mediaClock.
*
- * @param mediaClock a String value for the MediaClock
- * <p></p>
- * <b>Notes: </b>
- * <ul>
- * <li>Must be properly formatted as described in the
- * MediaClockFormat enumeration</li>
- * <li>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)</li>
- * </ul>
+ * @param mediaClock Text value for MediaClock field. Has to be properly formatted by Mobile App according to
+ * the module's capabilities. If this text is set, any automatic media clock updates
+ * previously set with SetMediaClockTimer will be stopped.
+ * {"string_min_length": 0, "string_max_length": 500}
+ * @since SmartDeviceLink 1.0.0
+ * @deprecated in SmartDeviceLink 7.1.0
*/
@Deprecated
public Show setMediaClock(String mediaClock) {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/TextFieldName.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/TextFieldName.java index 53f77428d..1c749cc7f 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/TextFieldName.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/TextFieldName.java @@ -65,8 +65,11 @@ public enum TextFieldName { statusBar,
/**
* Text value for MediaClock field; applies to "Show"
+ *
+ * @since SmartDeviceLink 1.0.0
+ * @deprecated in SmartDeviceLink 7.1.0
*/
-
+ @Deprecated
mediaClock,
/**
* The track field of NGN and GEN1.1 MFD displays. This field is only available for media applications; applies to "Show"
|