From c1ec931f00893322ace16a22ecd42a7f3a7c36e2 Mon Sep 17 00:00:00 2001 From: Santos Cordon Date: Fri, 24 Apr 2015 11:26:01 -0700 Subject: [PATCH] Fix up DisconnectCause description. Change-Id: Ib2b52b6f8bc8fe945df3684f4e1ed9e04f78b061 --- telecomm/java/android/telecom/DisconnectCause.java | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/telecomm/java/android/telecom/DisconnectCause.java b/telecomm/java/android/telecom/DisconnectCause.java index 73bcd0c422cb7..3a7faf645a8cb 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. */