PhoneAccountSuggestion

public final class PhoneAccountSuggestion
extends Object implements Parcelable

java.lang.Object
   ↳ android.telecom.PhoneAccountSuggestion


Summary

Constants

int REASON_FREQUENT

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

int REASON_INTRA_CARRIER

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

int REASON_NONE

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

int REASON_OTHER

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

int REASON_USER_SET

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

Inherited constants

Fields

public static final Creator<PhoneAccountSuggestion> CREATOR

Public constructors

PhoneAccountSuggestion(PhoneAccountHandle handle, int reason, boolean shouldAutoSelect)

Creates a new instance of PhoneAccountSuggestion.

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.

PhoneAccountHandle getPhoneAccountHandle()
int getReason()
int hashCode()

Returns a hash code value for the object.

boolean shouldAutoSelect()

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

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

REASON_FREQUENT

Added in API level 29
public static final int REASON_FREQUENT

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

Constant Value: 2 (0x00000002)

REASON_INTRA_CARRIER

Added in API level 29
public static final int REASON_INTRA_CARRIER

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

Constant Value: 1 (0x00000001)

REASON_NONE

Added in API level 29
public static final int REASON_NONE

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

Constant Value: 0 (0x00000000)

REASON_OTHER

Added in API level 29
public static final int REASON_OTHER

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

Constant Value: 4 (0x00000004)

REASON_USER_SET

Added in API level 29
public static final int REASON_USER_SET

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

Constant Value: 3 (0x00000003)

Fields

CREATOR

Added in API level 29
public static final Creator<PhoneAccountSuggestion> CREATOR

Public constructors

PhoneAccountSuggestion

Added in API level 29
public PhoneAccountSuggestion (PhoneAccountHandle handle, 
                int reason, 
                boolean shouldAutoSelect)

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 REASON_NONE, REASON_INTRA_CARRIER, REASON_FREQUENT, REASON_USER_SET, or REASON_OTHER

shouldAutoSelect boolean: Whether the dialer should automatically place the call using this account. See shouldAutoSelect().

Public methods

describeContents

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

Added in API level 29
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 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
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getPhoneAccountHandle

Added in API level 29
public PhoneAccountHandle getPhoneAccountHandle ()

Returns
PhoneAccountHandle The PhoneAccountHandle for this suggestion. This value cannot be null.

getReason

Added in API level 29
public int getReason ()

Returns
int The reason for this suggestion Value is REASON_NONE, REASON_INTRA_CARRIER, REASON_FREQUENT, REASON_USER_SET, or REASON_OTHER

hashCode

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

Returns
int a hash code value for this object.

shouldAutoSelect

Added in API level 29
public boolean shouldAutoSelect ()

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.

Returns
boolean true if the hint is to auto-select, false otherwise.

writeToParcel

Added in API level 29
public void writeToParcel (Parcel dest, 
                int flags)

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