Added in API level 29

PhoneAccountSuggestion


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

Summary

Constants
static Int

Indicates that the PhoneAccountHandle is suggested because the user uses it frequently for the number that we are calling.

static Int

Indicates that the PhoneAccountHandle is suggested because the number we're calling is on the same carrier, and therefore may have lower rates.

static Int

Indicates that this account is not suggested for use, but is still available.

static Int

Indicates that the PhoneAccountHandle is suggested for a reason not otherwise enumerated here.

static Int

Indicates that the PhoneAccountHandle is suggested because the user explicitly specified that it be used for the number we are calling.

Inherited constants
Public constructors
PhoneAccountSuggestion(handle: PhoneAccountHandle, reason: Int, shouldAutoSelect: Boolean)

Creates a new instance of PhoneAccountSuggestion.

Public methods
Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Boolean
equals(other: Any?)

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

PhoneAccountHandle

Int

Int

Returns a hash code value for the object.

Boolean

Suggests whether the dialer should automatically place the call using this account without user interaction.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<PhoneAccountSuggestion!>

Constants

REASON_FREQUENT

Added in API level 29
static val REASON_FREQUENT: Int

Indicates that the PhoneAccountHandle is suggested because the user uses it frequently for the number that we are calling.

Value: 2

REASON_INTRA_CARRIER

Added in API level 29
static val REASON_INTRA_CARRIER: Int

Indicates that the PhoneAccountHandle is suggested because the number we're calling is on the same carrier, and therefore may have lower rates.

Value: 1

REASON_NONE

Added in API level 29
static val REASON_NONE: Int

Indicates that this account is not suggested for use, but is still available.

Value: 0

REASON_OTHER

Added in API level 29
static val REASON_OTHER: Int

Indicates that the PhoneAccountHandle is suggested for a reason not otherwise enumerated here.

Value: 4

REASON_USER_SET

Added in API level 29
static val REASON_USER_SET: Int

Indicates that the PhoneAccountHandle is suggested because the user explicitly specified that it be used for the number we are calling.

Value: 3

Public constructors

PhoneAccountSuggestion

Added in API level 29
PhoneAccountSuggestion(
    handle: PhoneAccountHandle,
    reason: Int,
    shouldAutoSelect: Boolean)

Creates a new instance of PhoneAccountSuggestion. This constructor is intended for use by apps implementing a PhoneAccountSuggestionService, and generally should not be used by dialer apps other than for testing purposes.

Parameters
handle PhoneAccountHandle: The PhoneAccountHandle for this suggestion.
This value cannot be null.
reason Int: The reason for this suggestion.
Value is one of the following:
shouldAutoSelect Boolean: Whether the dialer should automatically place the call using this account. See shouldAutoSelect().

Public methods

describeContents

Added in API level 29
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

equals

Added in API level 29
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.

getPhoneAccountHandle

Added in API level 29
fun getPhoneAccountHandle(): PhoneAccountHandle
Return
PhoneAccountHandle The PhoneAccountHandle for this suggestion.
This value cannot be null.

getReason

Added in API level 29
fun getReason(): Int
Return
Int The reason for this suggestion.
Value is one of the following:

hashCode

Added in API level 29
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.

shouldAutoSelect

Added in API level 29
fun shouldAutoSelect(): Boolean

Suggests whether the dialer should automatically place the call using this account without user interaction. This may be set on multiple PhoneAccountSuggestions, and the dialer is free to choose which one to use.

Return
Boolean true if the hint is to auto-select, false otherwise.

writeToParcel

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

Flatten this object in to a Parcel.

Parameters
dest Parcel: 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 the following:

Properties

CREATOR

Added in API level 29
static val CREATOR: Parcelable.Creator<PhoneAccountSuggestion!>