Added in API level 34

CallAttributes


class CallAttributes : Parcelable
kotlin.Any
   ↳ android.telecom.CallAttributes

CallAttributes represents a set of properties that define a new Call. Apps should build an instance of this class and use TelecomManager#addCall to start a new call with Telecom.

Apps should first register a PhoneAccount via TelecomManager#registerPhoneAccount and use the same PhoneAccountHandle registered with Telecom when creating an instance of CallAttributes.

Summary

Nested classes

Build an instance of CallAttributes.

Constants
static Int

Used when answering or dialing a call to indicate that the call does not have a video component

static Int

Indicates that the call is an incoming call.

static Int

Indicates that the call is an outgoing call.

static Int

The call being created can be set to inactive (traditionally referred to as hold).

static Int

The call can be streamed from a root device to another device to continue the call without completely transferring it.

static Int

The call can be completely transferred from one endpoint to another.

static Int

The call supports video calling.

static Int

Indicates video transmission is supported

Inherited constants
Public methods
Int

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

Uri

Int

Int

Int

CharSequence

PhoneAccountHandle

The PhoneAccountHandle that should be registered to Telecom to allow calls.

Int

Returns a hash code value for the object.

String

Returns a string representation of the object.

Unit
writeToParcel(dest: Parcel!, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<CallAttributes!>

Responsible for creating CallAttribute objects for deserialized Parcels.

Constants

AUDIO_CALL

Added in API level 34
static val AUDIO_CALL: Int

Used when answering or dialing a call to indicate that the call does not have a video component

Value: 1

DIRECTION_INCOMING

Added in API level 34
static val DIRECTION_INCOMING: Int

Indicates that the call is an incoming call.

Value: 1

DIRECTION_OUTGOING

Added in API level 34
static val DIRECTION_OUTGOING: Int

Indicates that the call is an outgoing call.

Value: 2

SUPPORTS_SET_INACTIVE

Added in API level 34
static val SUPPORTS_SET_INACTIVE: Int

The call being created can be set to inactive (traditionally referred to as hold). This means that once a new call goes active, if the active call needs to be held in order to place or receive an incoming call, the active call will be placed on hold. otherwise, the active call may be disconnected.

Value: 2

SUPPORTS_STREAM

Added in API level 34
static val SUPPORTS_STREAM: Int

The call can be streamed from a root device to another device to continue the call without completely transferring it.

Value: 4

SUPPORTS_TRANSFER

Added in API level 34
static val SUPPORTS_TRANSFER: Int

The call can be completely transferred from one endpoint to another.

Value: 8

SUPPORTS_VIDEO_CALLING

Added in API level 35
static val SUPPORTS_VIDEO_CALLING: Int

The call supports video calling. This allows clients to gate video calling on a per call basis as opposed to re-registering the phone account.

Value: 16

VIDEO_CALL

Added in API level 34
static val VIDEO_CALL: Int

Indicates video transmission is supported

Value: 2

Public methods

describeContents

Added in API level 34
fun describeContents(): Int
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

equals

Added in API level 34
fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getAddress

Added in API level 34
fun getAddress(): Uri
Return
Uri address of the incoming caller or the address of the person being called for an outgoing call This value cannot be null.

getCallCapabilities

Added in API level 34
fun getCallCapabilities(): Int
Return
Int The allowed capabilities of the new call Value is either 0 or a combination of android.telecom.CallAttributes#SUPPORTS_SET_INACTIVE, android.telecom.CallAttributes#SUPPORTS_STREAM, android.telecom.CallAttributes#SUPPORTS_TRANSFER, and android.telecom.CallAttributes#SUPPORTS_VIDEO_CALLING

getCallType

Added in API level 34
fun getCallType(): Int
Return
Int Information related to data being transmitted (voice, video, etc. ) Value is android.telecom.CallAttributes#AUDIO_CALL, or android.telecom.CallAttributes#VIDEO_CALL

getDirection

Added in API level 34
fun getDirection(): Int
Return
Int the direction of the new call. Value is android.telecom.CallAttributes#DIRECTION_INCOMING, or android.telecom.CallAttributes#DIRECTION_OUTGOING

getDisplayName

Added in API level 34
fun getDisplayName(): CharSequence
Return
CharSequence display name of the incoming caller or the person being called for an outgoing call This value cannot be null.

getPhoneAccountHandle

Added in API level 34
fun getPhoneAccountHandle(): PhoneAccountHandle

The PhoneAccountHandle that should be registered to Telecom to allow calls. The PhoneAccountHandle should be registered before creating a CallAttributes instance.

Return
PhoneAccountHandle the PhoneAccountHandle for this package that allows this call to be created This value cannot be null.

hashCode

Added in API level 34
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Return
Int a hash code value for this object.

toString

Added in API level 34
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 34
fun writeToParcel(
    dest: Parcel!,
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel!: This value may 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 34
static val CREATOR: Parcelable.Creator<CallAttributes!>

Responsible for creating CallAttribute objects for deserialized Parcels.