PhoneAccountHandle

Kotlin |Java

class PhoneAccountHandle : Parcelable

kotlin.Any
↳	android.telecom.PhoneAccountHandle

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. Apps registering PhoneAccountHandles should ensure that the getId() provided does not expose personally identifying information. A ConnectionService should use an opaque token as the PhoneAccountHandle identifier.

Note: This Class requires a non-null ComponentName and UserHandle to operate properly. Passing in invalid parameters will generate a log warning. See PhoneAccount, TelecomManager.

Summary

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
`PhoneAccountHandle(componentName: ComponentName, id: String)` Creates a new `PhoneAccountHandle`.
`PhoneAccountHandle(componentName: ComponentName, id: String, userHandle: UserHandle)` Creates a new `PhoneAccountHandle`.

Public methods
Int	`describeContents()` 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.
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 a hash code value for the object.
String	`toString()` Returns a string representation of the object.
Unit	`writeToParcel(out: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<PhoneAccountHandle!>	`CREATOR`

Public constructors

PhoneAccountHandle

Added in API level 23

PhoneAccountHandle(
    componentName: ComponentName, 
    id: String)

Creates a new PhoneAccountHandle.

Parameters

componentName ComponentName: The ComponentName of the ConnectionService which services this PhoneAccountHandle.
This value cannot be null.

id

String: A string identifier that is unique across PhoneAccountHandles with the same component name. Apps registering PhoneAccountHandles should ensure that the ID provided does not expose personally identifying information. A ConnectionService should use an opaque token as the PhoneAccountHandle identifier.

Note: Each String field is limited to 256 characters. This check is enforced when registering the PhoneAccount via TelecomManager.registerPhoneAccount(PhoneAccount) and will cause an IllegalArgumentException to be thrown if the character field limit is over 256.
This value cannot be null.

PhoneAccountHandle

Added in API level 23

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

Creates a new PhoneAccountHandle.

Parameters
`componentName`	ComponentName: The `ComponentName` of the `ConnectionService` which services this `PhoneAccountHandle`. This value cannot be `null`.
`id`	String: A string identifier that is unique across `PhoneAccountHandle`s with the same component name. Apps registering `PhoneAccountHandle`s should ensure that the ID provided does not expose personally identifying information. A `ConnectionService` should use an opaque token as the `PhoneAccountHandle` identifier. This value cannot be `null`.
`userHandle`	UserHandle: The `UserHandle` associated with this `PhoneAccountHandle`. Note: Each String field is limited to 256 characters. This check is enforced when registering the PhoneAccount via `TelecomManager.registerPhoneAccount(PhoneAccount)` and will cause an `IllegalArgumentException` to be thrown if the character field limit is over 256. This value cannot be `null`.

Public methods

describeContents

Added in API level 23

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 `CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 23

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.

getComponentName

Added in API level 23

fun getComponentName(): ComponentName!

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

Return
`ComponentName!`	A suitable `ComponentName`.

getId

Added in API level 23

fun getId(): String!

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. The identifier should be a stable opaque token which uniquely identifies the user within the 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.

Return
`String!`	A service-specific unique opaque identifier for this `PhoneAccountHandle`.

getUserHandle

Added in API level 23

fun getUserHandle(): UserHandle!

Return
`UserHandle!`	the `UserHandle` to use when connecting to this PhoneAccount.

hashCode

Added in API level 23

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.

toString

Added in API level 23

fun toString(): String

Returns a string representation of the object.

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 23

fun writeToParcel(
    out: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	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: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 23

static val CREATOR: Parcelable.Creator<PhoneAccountHandle!>