CallAttributes
public
final
class
CallAttributes
extends Object
implements
Parcelable
java.lang.Object | |
↳ | 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 | |
---|---|
class |
CallAttributes.Builder
Build an instance of |
Constants | |
---|---|
int |
AUDIO_CALL
Used when answering or dialing a call to indicate that the call does not have a video component |
int |
DIRECTION_INCOMING
Indicates that the call is an incoming call. |
int |
DIRECTION_OUTGOING
Indicates that the call is an outgoing call. |
int |
SUPPORTS_SET_INACTIVE
The call being created can be set to inactive (traditionally referred to as hold). |
int |
SUPPORTS_STREAM
The call can be streamed from a root device to another device to continue the call without completely transferring it. |
int |
SUPPORTS_TRANSFER
The call can be completely transferred from one endpoint to another. |
int |
SUPPORTS_VIDEO_CALLING
The call supports video calling. |
int |
VIDEO_CALL
Indicates video transmission is supported |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<CallAttributes> |
CREATOR
Responsible for creating CallAttribute objects for deserialized Parcels. |
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
Uri
|
getAddress()
|
int
|
getCallCapabilities()
|
int
|
getCallType()
|
int
|
getDirection()
|
CharSequence
|
getDisplayName()
|
PhoneAccountHandle
|
getPhoneAccountHandle()
The |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Constants
AUDIO_CALL
public static final int AUDIO_CALL
Used when answering or dialing a call to indicate that the call does not have a video component
Constant Value: 1 (0x00000001)
DIRECTION_INCOMING
public static final int DIRECTION_INCOMING
Indicates that the call is an incoming call.
Constant Value: 1 (0x00000001)
DIRECTION_OUTGOING
public static final int DIRECTION_OUTGOING
Indicates that the call is an outgoing call.
Constant Value: 2 (0x00000002)
SUPPORTS_SET_INACTIVE
public static final int SUPPORTS_SET_INACTIVE
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.
Constant Value: 2 (0x00000002)
SUPPORTS_STREAM
public static final int SUPPORTS_STREAM
The call can be streamed from a root device to another device to continue the call without completely transferring it.
Constant Value: 4 (0x00000004)
SUPPORTS_TRANSFER
public static final int SUPPORTS_TRANSFER
The call can be completely transferred from one endpoint to another.
Constant Value: 8 (0x00000008)
SUPPORTS_VIDEO_CALLING
public static final int SUPPORTS_VIDEO_CALLING
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.
Constant Value: 16 (0x00000010)
VIDEO_CALL
public static final int VIDEO_CALL
Indicates video transmission is supported
Constant Value: 2 (0x00000002)
Fields
CREATOR
public static final Creator<CallAttributes> CREATOR
Responsible for creating CallAttribute objects for deserialized Parcels.
Public methods
describeContents
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 |
equals
public boolean equals (Object obj)
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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 |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getAddress
public Uri getAddress ()
Returns | |
---|---|
Uri |
address of the incoming caller
or the address of the person being called for an outgoing call
This value cannot be null . |
getCallCapabilities
public int getCallCapabilities ()
Returns | |
---|---|
int |
The allowed capabilities of the new call
Value is either 0 or a combination of SUPPORTS_SET_INACTIVE , SUPPORTS_STREAM , SUPPORTS_TRANSFER , and SUPPORTS_VIDEO_CALLING |
getCallType
public int getCallType ()
Returns | |
---|---|
int |
Information related to data being transmitted (voice, video, etc. )
Value is AUDIO_CALL , or VIDEO_CALL |
getDirection
public int getDirection ()
Returns | |
---|---|
int |
the direction of the new call.
Value is DIRECTION_INCOMING , or DIRECTION_OUTGOING |
getDisplayName
public CharSequence getDisplayName ()
Returns | |
---|---|
CharSequence |
display name of the incoming caller or the person being called for an outgoing call
This value cannot be null . |
getPhoneAccountHandle
public PhoneAccountHandle getPhoneAccountHandle ()
The PhoneAccountHandle
that should be registered to Telecom to allow calls. The
PhoneAccountHandle
should be registered before creating a CallAttributes instance.
Returns | |
---|---|
PhoneAccountHandle |
the PhoneAccountHandle for this package that allows this call to be created
This value cannot be null . |
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
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 inequals
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 thehashCode
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 thehashCode
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.
Returns | |
---|---|
int |
a hash code value for this object. |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
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.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-06-18 UTC.