Added in API level 23

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

ConnectionRequest

---

Kotlin |Java

public final class ConnectionRequest
extends Object implements Parcelable

java.lang.Object
↳	android.telecom.ConnectionRequest

---

Simple data container encapsulating a request to some entity to create a new Connection.

Summary

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<ConnectionRequest>	CREATOR

Public constructors
ConnectionRequest(PhoneAccountHandle accountHandle, Uri handle, Bundle extras)
ConnectionRequest(PhoneAccountHandle accountHandle, Uri handle, Bundle extras, int videoState)

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
PhoneAccountHandle	getAccountHandle() The account which should be used to place the call.
Uri	getAddress() The handle (e.g., phone number) to which the Connection is to connect.
Bundle	getExtras() Application-specific extra data.
List<Uri>	getParticipants() The participants to which the Connection is to connect.
Connection.RttTextStream	getRttTextStream() Gets the Connection.RttTextStream object that should be used to send and receive RTT text to/from the in-call app.
int	getVideoState() Describes the video states supported by the client requesting the connection.
boolean	isAdhocConferenceCall()
boolean	isRequestingRtt() Convenience method for determining whether the ConnectionRequest is requesting an RTT session
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel destination, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 23

public static final Creator<ConnectionRequest> CREATOR

Public constructors

ConnectionRequest

Added in API level 23

public ConnectionRequest (PhoneAccountHandle accountHandle, 
                Uri handle, 
                Bundle extras)

Parameters
accountHandle	PhoneAccountHandle: The accountHandle which should be used to place the call.
handle	Uri: The handle (e.g., phone number) to which the Connection is to connect.
extras	Bundle: Application-specific extra data.

ConnectionRequest

Added in API level 23

public ConnectionRequest (PhoneAccountHandle accountHandle, 
                Uri handle, 
                Bundle extras, 
                int videoState)

Parameters
accountHandle	PhoneAccountHandle: The accountHandle which should be used to place the call.
handle	Uri: The handle (e.g., phone number) to which the Connection is to connect.
extras	Bundle: Application-specific extra data.
videoState	int: Determines the video state for the connection.

Public methods

describeContents

Added in API level 23

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getAccountHandle

Added in API level 23

public PhoneAccountHandle getAccountHandle ()

The account which should be used to place the call.

Returns
PhoneAccountHandle

getAddress

Added in API level 23

public Uri getAddress ()

The handle (e.g., phone number) to which the Connection is to connect.

Returns
Uri

getExtras

Added in API level 23

public Bundle getExtras ()

Application-specific extra data. Used for passing back information from an incoming call Intent, and for any proprietary extensions arranged between a client and servant ConnectionService which agree on a vocabulary for such data.

Returns
Bundle

getParticipants

Added in API level 30

public List<Uri> getParticipants ()

The participants to which the Connection is to connect.

Returns
List<Uri>	This value may be null.

getRttTextStream

Added in API level 28

public Connection.RttTextStream getRttTextStream ()

Gets the Connection.RttTextStream object that should be used to send and receive RTT text to/from the in-call app.

Returns
Connection.RttTextStream	An instance of Connection.RttTextStream, or null if this connection request is not requesting an RTT session upon connection establishment.

getVideoState

Added in API level 23

public int getVideoState ()

Describes the video states supported by the client requesting the connection. Valid values: VideoProfile#STATE_AUDIO_ONLY, VideoProfile#STATE_BIDIRECTIONAL, VideoProfile#STATE_TX_ENABLED, VideoProfile#STATE_RX_ENABLED.

Returns
int	The video state for the connection.

isAdhocConferenceCall

Added in API level 30

public boolean isAdhocConferenceCall ()

Returns
boolean	true if the call is a adhoc conference call else @return false

isRequestingRtt

Added in API level 28

public boolean isRequestingRtt ()

Convenience method for determining whether the ConnectionRequest is requesting an RTT session

Returns
boolean	true if RTT is requested, false otherwise.

toString

Added in API level 23

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 23

public void writeToParcel (Parcel destination, 
                int flags)

Flatten this object in to a Parcel.

Parameters
destination	Parcel: The Parcel in which the object should be written. This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES