summaryrefslogtreecommitdiffstats
path: root/telecomm/java/android/telecom/DisconnectCause.java
diff options
context:
space:
mode:
authorSantos Cordon <santoscordon@google.com>2015-04-24 11:26:01 -0700
committerSantos Cordon <santoscordon@google.com>2015-04-24 11:37:07 -0700
commitc1ec931f00893322ace16a22ecd42a7f3a7c36e2 (patch)
tree9d08a44947ab1becfd1acbf89b6350f3fc84f0c6 /telecomm/java/android/telecom/DisconnectCause.java
parent7defaef1bfc05757652d3a5d00d35090397e7f3e (diff)
downloadframeworks_base-c1ec931f00893322ace16a22ecd42a7f3a7c36e2.zip
frameworks_base-c1ec931f00893322ace16a22ecd42a7f3a7c36e2.tar.gz
frameworks_base-c1ec931f00893322ace16a22ecd42a7f3a7c36e2.tar.bz2
Fix up DisconnectCause description.
Change-Id: Ib2b52b6f8bc8fe945df3684f4e1ed9e04f78b061
Diffstat (limited to 'telecomm/java/android/telecom/DisconnectCause.java')
-rw-r--r--telecomm/java/android/telecom/DisconnectCause.java13
1 files changed, 9 insertions, 4 deletions
diff --git a/telecomm/java/android/telecom/DisconnectCause.java b/telecomm/java/android/telecom/DisconnectCause.java
index 73bcd0c..3a7faf6 100644
--- a/telecomm/java/android/telecom/DisconnectCause.java
+++ b/telecomm/java/android/telecom/DisconnectCause.java
@@ -130,8 +130,10 @@ public final class DisconnectCause implements Parcelable {
/**
* Returns a short label which explains the reason for the disconnect cause and is for display
- * in the user interface. The {@link ConnectionService } is responsible for providing and
- * localizing this label. If there is no string provided, returns null.
+ * in the user interface. If not null, it is expected that the In-Call UI should display this
+ * text where it would normally display the call state ("Dialing", "Disconnected") and is
+ * therefore expected to be relatively small. The {@link ConnectionService } is responsible for
+ * providing and localizing this label. If there is no string provided, returns null.
*
* @return The disconnect label.
*/
@@ -141,8 +143,11 @@ public final class DisconnectCause implements Parcelable {
/**
* Returns a description which explains the reason for the disconnect cause and is for display
- * in the user interface. The {@link ConnectionService } is responsible for providing and
- * localizing this message. If there is no string provided, returns null.
+ * in the user interface. This optional text is generally a longer and more descriptive version
+ * of {@link #getLabel}, however it can exist even if {@link #getLabel} is empty. The In-Call UI
+ * should display this relatively prominently; the traditional implementation displays this as
+ * an alert dialog. The {@link ConnectionService} is responsible for providing and localizing
+ * this message. If there is no string provided, returns null.
*
* @return The disconnect description.
*/