| java.lang.Object | |
| ↳ | android.telecom.PhoneAccount |
Represents a distinct method to place or receive a phone call. Apps which can place calls and
want those calls to be integrated into the dialer and in-call UI should build an instance of
this class and register it with the system using TelecomManager.
TelecomManager uses registered PhoneAccounts to present the user with
alternative options when placing a phone call. When building a PhoneAccount, the app
should supply a valid PhoneAccountHandle that references the connection service
implementation Telecom will use to interact with the app.
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| PhoneAccount.Builder |
Helper class for creating a PhoneAccount.
|
||||||||||
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | CAPABILITY_CALL_PROVIDER |
Flag indicating that this PhoneAccount can make phone calls in place of
traditional SIM-based telephony calls.
|
|||||||||
| int | CAPABILITY_CALL_SUBJECT |
Flag indicating that this PhoneAccount supports a subject for Calls.
|
|||||||||
| int | CAPABILITY_CONNECTION_MANAGER |
Flag indicating that this PhoneAccount can act as a connection manager for
other connections.
|
|||||||||
| int | CAPABILITY_PLACE_EMERGENCY_CALLS |
Flag indicating that this PhoneAccount is capable of placing emergency calls.
|
|||||||||
| int | CAPABILITY_SIM_SUBSCRIPTION |
Flag indicating that this PhoneAccount represents a built-in PSTN SIM
subscription.
|
|||||||||
| int | CAPABILITY_VIDEO_CALLING |
Flag indicating that this PhoneAccount is capable of placing video calls.
|
|||||||||
| int | NO_HIGHLIGHT_COLOR | Indicating no hightlight color is set. | |||||||||
| int | NO_RESOURCE_ID | Indicating no resource ID is set. | |||||||||
| String | SCHEME_SIP | URI scheme for SIP URIs. | |||||||||
| String | SCHEME_TEL | URI scheme for telephone number URIs. | |||||||||
| String | SCHEME_VOICEMAIL | URI scheme for voicemail URIs. | |||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From interface
android.os.Parcelable
| |||||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| CREATOR | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Describe the kinds of special objects contained in this Parcelable's
marshalled representation.
| |||||||||||
The unique identifier of this
PhoneAccount.
| |||||||||||
The address (e.g., a phone number) associated with this
PhoneAccount.
| |||||||||||
The capabilities of this
PhoneAccount.
| |||||||||||
A highlight color to use in displaying information about this
PhoneAccount.
| |||||||||||
The icon to represent this
PhoneAccount.
| |||||||||||
A short label describing a
PhoneAccount.
| |||||||||||
A short paragraph describing this
PhoneAccount.
| |||||||||||
The raw callback number used for this
PhoneAccount, as distinct from
getAddress().
| |||||||||||
The URI schemes supported by this
PhoneAccount.
| |||||||||||
Determines if this
PhoneAccount has a capabilities specified by the passed in
bit mask.
| |||||||||||
Indicates whether the user has enabled this
PhoneAccount or not.
| |||||||||||
Determines if the
PhoneAccount supports calls to/from addresses with a specified URI
scheme.
| |||||||||||
Returns a builder initialized with the current
PhoneAccount instance.
| |||||||||||
Returns a string containing a concise, human-readable description of this
object.
| |||||||||||
Flatten this object in to a Parcel.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
|
From interface
android.os.Parcelable
| |||||||||||
Flag indicating that this PhoneAccount can make phone calls in place of
traditional SIM-based telephony calls. This account will be treated as a distinct method
for placing calls alongside the traditional SIM-based telephony stack. This flag is
distinct from CAPABILITY_CONNECTION_MANAGER in that it is not allowed to manage
or place calls from the built-in telephony stack.
Flag indicating that this PhoneAccount supports a subject for Calls. This means a
caller is able to specify a short subject line for an outgoing call. A capable receiving
device displays the call subject on the incoming call screen.
Flag indicating that this PhoneAccount can act as a connection manager for
other connections. The ConnectionService associated with this PhoneAccount
will be allowed to manage phone calls including using its own proprietary phone-call
implementation (like VoIP calling) to make calls instead of the telephony stack.
When a user opts to place a call using the SIM-based telephony stack, the
ConnectionService associated with this PhoneAccount will be attempted first
if the user has explicitly selected it to be used as the default connection manager.
Flag indicating that this PhoneAccount is capable of placing emergency calls.
By default all PSTN PhoneAccounts are capable of placing emergency calls.
Flag indicating that this PhoneAccount represents a built-in PSTN SIM
subscription.
Only the Android framework can register a PhoneAccount having this capability.
Flag indicating that this PhoneAccount is capable of placing video calls.
Indicating no hightlight color is set.
Indicating no resource ID is set.
URI scheme for SIP URIs.
URI scheme for telephone number URIs.
URI scheme for voicemail URIs.
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
The unique identifier of this PhoneAccount.
Developers
PhoneAccountHandle.
The address (e.g., a phone number) associated with this PhoneAccount. This
represents the destination from which outgoing calls using this PhoneAccount
will appear to come, if applicable, and the destination to which incoming calls using this
PhoneAccount may be addressed.
Uri, for example, a phone number.
The capabilities of this PhoneAccount.
PhoneAccount's capabilities.
A highlight color to use in displaying information about this PhoneAccount.
The icon to represent this PhoneAccount.
A short label describing a PhoneAccount.
PhoneAccount.
A short paragraph describing this PhoneAccount.
PhoneAccount.
The raw callback number used for this PhoneAccount, as distinct from
getAddress(). For the majority of PhoneAccounts this should be registered
as null. It is used by the system for SIM-based PhoneAccount registration
where setLine1NumberForDisplay(String, String)
has been used to alter the callback number.
The URI schemes supported by this PhoneAccount.
Determines if this PhoneAccount has a capabilities specified by the passed in
bit mask.
| capability | The capabilities to check. |
|---|
true if the phone account has the capability.
Indicates whether the user has enabled this PhoneAccount or not. This value is only
populated for PhoneAccounts returned by getPhoneAccount(PhoneAccountHandle).
true if the account is enabled by the user, false otherwise.
Determines if the PhoneAccount supports calls to/from addresses with a specified URI
scheme.
| uriScheme | The URI scheme to check. |
|---|
true if the PhoneAccount supports calls to/from addresses with the
specified URI scheme.
Returns a builder initialized with the current PhoneAccount instance.
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.
Flatten this object in to a Parcel.
| 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.
|