Android APIs
public final class

PhoneAccountHandle

extends Object
implements Parcelable
java.lang.Object
   ↳ android.telecom.PhoneAccountHandle

Class Overview

The unique identifier for a PhoneAccount. A PhoneAccountHandle is made of two parts:

  • The component name of the associated connection service.
  • A string identifier that is unique across PhoneAccountHandles with the same component name.
See PhoneAccount, TelecomManager.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<PhoneAccountHandle> CREATOR
Public Constructors
PhoneAccountHandle(ComponentName componentName, String id)
PhoneAccountHandle(ComponentName componentName, String id, UserHandle userHandle)
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean equals(Object other)
Compares this instance with the specified object and indicates if they are equal.
ComponentName getComponentName()
The ComponentName of the connection service which is responsible for making phone calls using this PhoneAccountHandle.
String getId()
A string that uniquely distinguishes this particular PhoneAccountHandle from all the others supported by the connection service that created it.
UserHandle getUserHandle()
int hashCode()
Returns an integer hash code for this object.
String toString()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel(Parcel out, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<PhoneAccountHandle> CREATOR

Added in API level 23

Public Constructors

public PhoneAccountHandle (ComponentName componentName, String id)

Added in API level 23

public PhoneAccountHandle (ComponentName componentName, String id, UserHandle userHandle)

Added in API level 23

Public Methods

public int describeContents ()

Added in API level 23

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

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean equals (Object other)

Added in API level 23

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
other the object to compare this instance with.
Returns
  • true if the specified object is equal to this Object; false otherwise.

public ComponentName getComponentName ()

Added in API level 23

The ComponentName of the connection service which is responsible for making phone calls using this PhoneAccountHandle.

Returns
  • A suitable ComponentName.

public String getId ()

Added in API level 23

A string that uniquely distinguishes this particular PhoneAccountHandle from all the others supported by the connection service that created it.

A connection service must select identifiers that are stable for the lifetime of their users' relationship with their service, across many Android devices. For example, a good set of identifiers might be the email addresses with which with users registered for their accounts with a particular service. Depending on how a service chooses to operate, a bad set of identifiers might be an increasing series of integers (0, 1, 2, ...) that are generated locally on each phone and could collide with values generated on other phones or after a data wipe of a given phone. Important: A non-unique identifier could cause non-deterministic call-log backup/restore behavior.

Returns
  • A service-specific unique identifier for this PhoneAccountHandle.

public UserHandle getUserHandle ()

Added in API level 23

Returns
  • the UserHandle to use when connecting to this PhoneAccount.

public int hashCode ()

Added in API level 23

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
  • this object's hash code.

public String toString ()

Added in API level 23

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.

public void writeToParcel (Parcel out, int flags)

Added in API level 23

Flatten this object in to a Parcel.

Parameters
out The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.