CallIdentification
public
final
class
CallIdentification
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.telecom.CallIdentification |
Encapsulates information about an incoming or outgoing Call provided by a
CallScreeningService.
Call identified information is consumed by the InCallService app to provide the
user with more information about a call. This can include information such as the name of the
caller, address, etc. Call identification information is persisted to the
CallLog.
Summary
Nested classes | |
|---|---|
class |
CallIdentification.Builder
Builder for |
Constants | |
|---|---|
int |
CONFIDENCE_LIKELY_NOT_NUISANCE
Call has been identified as not likely to be a nuisance call. |
int |
CONFIDENCE_LIKELY_NUISANCE
Call has been identified as a likely nuisance call. |
int |
CONFIDENCE_NOT_NUISANCE
Call has been identified as not a nuisance call. |
int |
CONFIDENCE_NUISANCE
Call has been identified as a nuisance call. |
int |
CONFIDENCE_UNKNOWN
Call could not be classified as nuisance or non-nuisance. |
Inherited constants |
|---|
Fields | |
|---|---|
public
static
final
Creator<CallIdentification> |
CREATOR
Responsible for creating CallIdentification 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 o)
Indicates whether some other object is "equal to" this one. |
CharSequence
|
getCallScreeningAppName()
The |
String
|
getCallScreeningPackageName()
The package name of the |
CharSequence
|
getDescription()
Description of the call. |
CharSequence
|
getDetails()
Details of the call. |
CharSequence
|
getName()
The name associated with the number. |
int
|
getNuisanceConfidence()
Indicates the likelihood that this call is a nuisance call. |
Icon
|
getPhoto()
Photo associated with the call. |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel parcel, int i)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Constants
CONFIDENCE_LIKELY_NOT_NUISANCE
public static final int CONFIDENCE_LIKELY_NOT_NUISANCE
Call has been identified as not likely to be a nuisance call.
Returned from getNuisanceConfidence() to indicate that a
CallScreeningService to indicate how confident it is that a call is or is not a
nuisance call.
Constant Value: -1 (0xffffffff)
CONFIDENCE_LIKELY_NUISANCE
public static final int CONFIDENCE_LIKELY_NUISANCE
Call has been identified as a likely nuisance call.
Returned from getNuisanceConfidence() to indicate that a
CallScreeningService to indicate how confident it is that a call is or is not a
nuisance call.
Constant Value: 1 (0x00000001)
CONFIDENCE_NOT_NUISANCE
public static final int CONFIDENCE_NOT_NUISANCE
Call has been identified as not a nuisance call.
Returned from getNuisanceConfidence() to indicate that a
CallScreeningService to indicate how confident it is that a call is or is not a
nuisance call.
Constant Value: -2 (0xfffffffe)
CONFIDENCE_NUISANCE
public static final int CONFIDENCE_NUISANCE
Call has been identified as a nuisance call.
Returned from getNuisanceConfidence() to indicate that a
CallScreeningService to indicate how confident it is that a call is or is not a
nuisance call.
Constant Value: 2 (0x00000002)
CONFIDENCE_UNKNOWN
public static final int CONFIDENCE_UNKNOWN
Call could not be classified as nuisance or non-nuisance.
Returned from getNuisanceConfidence() to indicate that a
CallScreeningService to indicate how confident it is that a call is or is not a
nuisance call.
Constant Value: 0 (0x00000000)
Fields
CREATOR
public static final Creator<CallIdentification> CREATOR
Responsible for creating CallIdentification 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 o)
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
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x and
y, this method returns true if and only
if x and y refer to the same object
(x == y has the value true).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode method, which states
that equal objects must have equal hash codes.
| Parameters | |
|---|---|
o |
Object: the reference object with which to compare. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getCallScreeningAppName
public CharSequence getCallScreeningAppName ()
The name of
the CallScreeningService which provided the CallIdentification.
A CallScreeningService may not set this property; it is set by the system.
| Returns | |
|---|---|
CharSequence |
The name of the app.
This value will never be null. |
getCallScreeningPackageName
public String getCallScreeningPackageName ()
The package name of the CallScreeningService which provided the
CallIdentification.
A CallScreeningService may not set this property; it is set by the system.
| Returns | |
|---|---|
String |
the package name
This value will never be null. |
getDescription
public CharSequence getDescription ()
Description of the call.
A description of the call as identified by a CallScreeningService. The description
is typically presented by Dialer apps after the name to provide a short
piece of relevant information about the call. This could include a location, address, or a
message regarding the potential nature of the call (e.g. potential telemarketer).
| Returns | |
|---|---|
CharSequence |
The call description, or null if none was provided. |
getDetails
public CharSequence getDetails ()
Details of the call.
Details of the call as identified by a CallScreeningService. The details
are typically presented by Dialer apps after the name and
description to provide further clarifying information about the
call. This could include, for example, the opening hours of a business, or stats about
the number of times a call has been reported as spam.
| Returns | |
|---|---|
CharSequence |
The call details, or null if none was provided. |
getName
public CharSequence getName ()
The name associated with the number.
The name of the call as identified by a CallScreeningService. Could be a business
name, for example.
| Returns | |
|---|---|
CharSequence |
The name associated with the number, or null if none was provided. |
getNuisanceConfidence
public int getNuisanceConfidence ()
Indicates the likelihood that this call is a nuisance call.
How likely the call is a nuisance call, as identified by a CallScreeningService.
| Returns | |
|---|---|
int |
The nuisance confidence.
Value is CONFIDENCE_NUISANCE, CONFIDENCE_LIKELY_NUISANCE, CONFIDENCE_UNKNOWN, CONFIDENCE_LIKELY_NOT_NUISANCE, or CONFIDENCE_NOT_NUISANCE |
getPhoto
public Icon getPhoto ()
Photo associated with the call.
A photo associated with the call as identified by a CallScreeningService. This
could be, for example, a business logo, or a photo of the caller.
| Returns | |
|---|---|
Icon |
The photo associated with the call, or null if none was provided. |
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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(Object)method, then calling thehashCodemethod 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(java.lang.Object)method, then calling thehashCodemethod 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.
As much as is reasonably practical, the hashCode method defined by
class Object does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
| Returns | |
|---|---|
int |
a hash code value for this object. |
toString
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
public void writeToParcel (Parcel parcel, int i)
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
parcel |
Parcel: The Parcel in which the object should be written. |
i |
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 is a registered trademark of Oracle and/or its affiliates.