Added cancel id documentation to modal views

4 files changed, 11 insertions, 4 deletions

diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Alert.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Alert.java
index 7a7fb8f94..a67484131 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Alert.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Alert.java
@@ -39,7 +39,9 @@ import java.util.List;
 

 /**

  * Provides information to the user using either TTS, the Display or both and

- * can include a system-generated alert tone

+ * can include a system-generated alert tone.

+ *

+ * If connecting to SDL Core v.6.0+, the alert can be canceled programmatically using the `cancelID`. Canceling will not dismiss the alert's speech - only the modal view will be dismissed. On older versions of SDL Core, the alert will persist until the user has interacted with the alert or the specified timeout has elapsed.

  * 

  * <ul>

  * <li>The displayed portion of the Alert, if any, will persist until the

diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteraction.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteraction.java
index 5a4b6170d..5e253e540 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteraction.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteraction.java
@@ -47,7 +47,9 @@ import java.util.List;
  * 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></p>

+ *

+ * If connecting to SDL Core v.6.0+, the perform interaction can be canceled programmatically using the `cancelID`. On older versions of SDL Core, the perform interaction will persist until the user has interacted with the perform interaction or the specified timeout has elapsed.

+ *

  * <p>Function Group: Base</p>

  * 

  * <p><b>HMILevel needs to be FULL</b></p>

diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java
index 29b81a4b3..d20635115 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java
@@ -42,6 +42,8 @@ import java.util.List;
 /**

  * Creates a full screen overlay containing a large block of formatted text that

  * can be scrolled with up to 8 SoftButtons defined

+ *

+ * If connecting to SDL Core v.6.0+, the scrollable message can be canceled programmatically using the `cancelID`. On older versions of SDL Core, the scrollable message will persist until the user has interacted with the scrollable message or the specified timeout has elapsed.

  * 

  * <p>Function Group: ScrollableMessage</p>

  * 

diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java
index 2809d4b3d..466879845 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java
@@ -40,8 +40,9 @@ import java.util.Hashtable;
 import java.util.List;

 

 /**

- * <p>Creates a full screen or pop-up overlay (depending on platform) with a single

- * user controlled slider.</p>

+ * Creates a full screen or pop-up overlay (depending on platform) with a single user controlled slider.

+ *

+ * If connecting to SDL Core v.6.0+, the slider can be canceled programmatically using the `cancelID`. On older versions of SDL Core, the slider will persist until the user has interacted with the slider or the specified timeout has elapsed.

  *

  * <p>Function Group: Base</p>

  *