Call.EventDisplayDiagnosticMessage Field
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Event reported from the Telecom stack to report an in-call diagnostic message which the dialer app may opt to display to the user.
[Android.Runtime.Register("EVENT_DISPLAY_DIAGNOSTIC_MESSAGE", ApiSince=31)]
public const string EventDisplayDiagnosticMessage;[<Android.Runtime.Register("EVENT_DISPLAY_DIAGNOSTIC_MESSAGE", ApiSince=31)>]
val mutable EventDisplayDiagnosticMessage : stringField Value
- Attributes
Remarks
Event reported from the Telecom stack to report an in-call diagnostic message which the dialer app may opt to display to the user. A diagnostic message is used to communicate scenarios the device has detected which may impact the quality of the ongoing call.
For example a problem with a bluetooth headset may generate a recommendation for the user to try using the speakerphone instead, or if the device detects it has entered a poor service area, the user might be warned so that they can finish their call prior to it dropping.
A diagnostic message is considered persistent in nature. When the user enters a poor service area, for example, the accompanying diagnostic message persists until they leave the area of poor service. Each message is accompanied with a #EXTRA_DIAGNOSTIC_MESSAGE_ID which uniquely identifies the diagnostic condition being reported. The framework raises a call event of type #EVENT_CLEAR_DIAGNOSTIC_MESSAGE when the condition reported has been cleared. The dialer app should display the diagnostic message until it is cleared. If multiple diagnostic messages are sent with different IDs (which have not yet been cleared) the dialer app should prioritize the most recently received message, but still provide the user with a means to review past messages.
The text of the message is found in #EXTRA_DIAGNOSTIC_MESSAGE in the form of a human readable CharSequence which is intended for display in the call UX.
The telecom framework audibly notifies the user of the presence of a diagnostic message, so the dialer app needs only to concern itself with visually displaying the message.
The dialer app receives this event via Call.Callback#onConnectionEvent(Call, String, Bundle).
Java documentation for android.telecom.Call.EVENT_DISPLAY_DIAGNOSTIC_MESSAGE.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.