ConnectionRequest

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

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.

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 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

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(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.

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

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.

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. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

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.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.