ConnectionRequest

Kotlin |Java

class ConnectionRequest : Parcelable

kotlin.Any
↳	android.telecom.ConnectionRequest

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

Summary

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public constructors
`ConnectionRequest(accountHandle: PhoneAccountHandle!, handle: Uri!, extras: Bundle!)`
`ConnectionRequest(accountHandle: PhoneAccountHandle!, handle: Uri!, extras: Bundle!, videoState: Int)`

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
Bundle!	`getExtras()` Application-specific extra data.
MutableList<Uri!>?	`getParticipants()` The participants to which the `Connection` is to connect.
Connection.RttTextStream!	`getRttTextStream()` Gets the `android.telecom.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()`
Unit	`writeToParcel(destination: Parcel, flags: Int)`

Properties
static Parcelable.Creator<ConnectionRequest!>	`CREATOR`

Public constructors

ConnectionRequest

Added in API level 23

ConnectionRequest(
    accountHandle: PhoneAccountHandle!, 
    handle: Uri!, 
    extras: Bundle!)

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

ConnectionRequest(
    accountHandle: PhoneAccountHandle!, 
    handle: Uri!, 
    extras: Bundle!, 
    videoState: Int)

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

fun describeContents(): Int

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.

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

getAccountHandle

Added in API level 23

fun getAccountHandle(): PhoneAccountHandle!

The account which should be used to place the call.

getAddress

Added in API level 23

fun getAddress(): Uri!

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

getExtras

Added in API level 23

fun getExtras(): Bundle!

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.

getParticipants

Added in API level 30

fun getParticipants(): MutableList<Uri!>?

The participants to which the Connection is to connect.

Return
`MutableList<Uri!>?`	This value may be `null`.

getRttTextStream

Added in API level 28

fun getRttTextStream(): Connection.RttTextStream!

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

Return
`Connection.RttTextStream!`	An instance of `android.telecom.Connection.RttTextStream`, or `null` if this connection request is not requesting an RTT session upon connection establishment.

getVideoState

Added in API level 23

fun getVideoState(): Int

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.

Return
`Int`	The video state for the connection.

isAdhocConferenceCall

Added in API level 30

fun isAdhocConferenceCall(): Boolean

Return
`Boolean`	`true` if the call is a adhoc conference call else @return `false`

isRequestingRtt

Added in API level 28

fun isRequestingRtt(): Boolean

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

Return
`Boolean`	`true` if RTT is requested, `false` otherwise.

toString

Added in API level 23

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 23

fun writeToParcel(
    destination: Parcel, 
    flags: Int
): Unit

Parameters
`dest`	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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 23

static val CREATOR: Parcelable.Creator<ConnectionRequest!>