Share via


Conference.SendConferenceEvent(String, Bundle) Method

Definition

Sends an event associated with this Conference with associated event extras to the InCallService.

[Android.Runtime.Register("sendConferenceEvent", "(Ljava/lang/String;Landroid/os/Bundle;)V", "GetSendConferenceEvent_Ljava_lang_String_Landroid_os_Bundle_Handler", ApiSince=30)]
public virtual void SendConferenceEvent (string e, Android.OS.Bundle? extras);
[<Android.Runtime.Register("sendConferenceEvent", "(Ljava/lang/String;Landroid/os/Bundle;)V", "GetSendConferenceEvent_Ljava_lang_String_Landroid_os_Bundle_Handler", ApiSince=30)>]
abstract member SendConferenceEvent : string * Android.OS.Bundle -> unit
override this.SendConferenceEvent : string * Android.OS.Bundle -> unit

Parameters

e
String
extras
Bundle

Optional bundle containing extra information associated with the event.

Attributes

Remarks

Sends an event associated with this Conference with associated event extras to the InCallService.

Connection events are used to communicate point in time information from a ConnectionService to an InCallService implementation. An example of a custom connection event includes notifying the UI when a WIFI call has been handed over to LTE, which the InCall UI might use to inform the user that billing charges may apply. The Android Telephony framework will send the Connection#EVENT_MERGE_COMPLETE connection event when a call to Call#mergeConference() has completed successfully.

Events are exposed to InCallService implementations via Call.Callback#onConnectionEvent(Call, String, Bundle).

No assumptions should be made as to how an In-Call UI or service will handle these events. The ConnectionService must assume that the In-Call UI could even chose to ignore some events altogether.

Events should be fully qualified (e.g. com.example.event.MY_EVENT) to avoid conflicts between ConnectionService implementations. Further, custom ConnectionService implementations shall not re-purpose events in the android.* namespace, nor shall they define new event types in this namespace. When defining a custom event type, ensure the contents of the extras Bundle is clearly defined. Extra keys for this bundle should be named similar to the event type (e.g. com.example.extra.MY_EXTRA).

When defining events and the associated extras, it is important to keep their behavior consistent when the associated ConnectionService is updated. Support for deprecated events/extras should me maintained to ensure backwards compatibility with older InCallService implementations which were built to support the older behavior.

Expected connection events from the Telephony stack are:

<ul> <li>Connection#EVENT_CALL_HOLD_FAILED with nullextras when the Conference could not be held.</li> <li>Connection#EVENT_MERGE_START with nullextras when a new call is being merged into the conference.</li> <li>Connection#EVENT_MERGE_COMPLETE with nullextras a new call has completed being merged into the conference.</li> <li>Connection#EVENT_CALL_MERGE_FAILED with nullextras a new call has failed to merge into the conference (the dialer app can determine which call failed to merge based on the fact that the call still exists outside of the conference at the end of the merge process).</li> </ul>

Java documentation for android.telecom.Conference.sendConferenceEvent(java.lang.String, android.os.Bundle).

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.

Applies to