/* * Copyright (C) 2014 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.telecom; import android.annotation.SystemApi; import android.content.ComponentName; import android.content.Context; import android.content.pm.PackageManager; import android.content.res.Resources.NotFoundException; import android.graphics.Bitmap; import android.graphics.Color; import android.graphics.drawable.BitmapDrawable; import android.graphics.drawable.ColorDrawable; import android.graphics.drawable.Drawable; import android.graphics.drawable.Icon; import android.net.Uri; import android.os.Bundle; import android.os.Parcel; import android.os.Parcelable; import android.text.TextUtils; import java.lang.String; import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.MissingResourceException; /** * 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 {@link TelecomManager}. *
* {@link TelecomManager} uses registered {@link PhoneAccount}s to present the user with * alternative options when placing a phone call. When building a {@link PhoneAccount}, the app * should supply a valid {@link PhoneAccountHandle} that references the connection service * implementation Telecom will use to interact with the app. */ public final class PhoneAccount implements Parcelable { /** * {@link PhoneAccount} extras key (see {@link PhoneAccount#getExtras()}) which determines the * maximum permitted length of a call subject specified via the * {@link TelecomManager#EXTRA_CALL_SUBJECT} extra on an * {@link android.content.Intent#ACTION_CALL} intent. Ultimately a {@link ConnectionService} is * responsible for enforcing the maximum call subject length when sending the message, however * this extra is provided so that the user interface can proactively limit the length of the * call subject as the user types it. */ public static final String EXTRA_CALL_SUBJECT_MAX_LENGTH = "android.telecom.extra.CALL_SUBJECT_MAX_LENGTH"; /** * {@link PhoneAccount} extras key (see {@link PhoneAccount#getExtras()}) which determines the * character encoding to be used when determining the length of messages. * The user interface can use this when determining the number of characters the user may type * in a call subject. If empty-string, the call subject message size limit will be enforced on * a 1:1 basis. That is, each character will count towards the messages size limit as a single * character. If a character encoding is specified, the message size limit will be based on the * number of bytes in the message per the specified encoding. See * {@link #EXTRA_CALL_SUBJECT_MAX_LENGTH} for more information on the call subject maximum * length. */ public static final String EXTRA_CALL_SUBJECT_CHARACTER_ENCODING = "android.telecom.extra.CALL_SUBJECT_CHARACTER_ENCODING"; /** * Flag indicating that this {@code PhoneAccount} can act as a connection manager for * other connections. The {@link ConnectionService} associated with this {@code 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 * {@link ConnectionService} associated with this {@code PhoneAccount} will be attempted first * if the user has explicitly selected it to be used as the default connection manager. *
* See {@link #getCapabilities} */ public static final int CAPABILITY_CONNECTION_MANAGER = 0x1; /** * Flag indicating that this {@code 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 {@link #CAPABILITY_CONNECTION_MANAGER} in that it is not allowed to manage * or place calls from the built-in telephony stack. *
* See {@link #getCapabilities} *
*/ public static final int CAPABILITY_CALL_PROVIDER = 0x2; /** * Flag indicating that this {@code PhoneAccount} represents a built-in PSTN SIM * subscription. *
* Only the Android framework can register a {@code PhoneAccount} having this capability. *
* See {@link #getCapabilities} */ public static final int CAPABILITY_SIM_SUBSCRIPTION = 0x4; /** * Flag indicating that this {@code PhoneAccount} is capable of placing video calls. *
* See {@link #getCapabilities} */ public static final int CAPABILITY_VIDEO_CALLING = 0x8; /** * Flag indicating that this {@code PhoneAccount} is capable of placing emergency calls. * By default all PSTN {@code PhoneAccount}s are capable of placing emergency calls. *
* See {@link #getCapabilities} */ public static final int CAPABILITY_PLACE_EMERGENCY_CALLS = 0x10; /** * Flag indicating that this {@code PhoneAccount} is capable of being used by all users. This * should only be used by system apps (and will be ignored for all other apps trying to use it). *
* See {@link #getCapabilities} * @hide */ @SystemApi public static final int CAPABILITY_MULTI_USER = 0x20; /** * Flag indicating that this {@code 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. *
* See {@link #getCapabilities} */ public static final int CAPABILITY_CALL_SUBJECT = 0x40; /** * Flag indicating that this {@code PhoneAccount} should only be used for emergency calls. *
* See {@link #getCapabilities} * @hide */ public static final int CAPABILITY_EMERGENCY_CALLS_ONLY = 0x80; /** * Flag indicating that for this {@code PhoneAccount}, the ability to make a video call to a * number relies on presence. Should only be set if the {@code PhoneAccount} also has * {@link #CAPABILITY_VIDEO_CALLING}. *
* When set, the {@link ConnectionService} is responsible for toggling the * {@link android.provider.ContactsContract.Data#CARRIER_PRESENCE_VT_CAPABLE} bit on the * {@link android.provider.ContactsContract.Data#CARRIER_PRESENCE} column to indicate whether * a contact's phone number supports video calling. *
* See {@link #getCapabilities} */ public static final int CAPABILITY_VIDEO_CALLING_RELIES_ON_PRESENCE = 0x100; /** * Flag indicating that for this {@link PhoneAccount}, emergency video calling is allowed. *
* When set, Telecom will allow emergency video calls to be placed. When not set, Telecom will
* convert all outgoing video calls to emergency numbers to audio-only.
* @hide
*/
public static final int CAPABILITY_EMERGENCY_VIDEO_CALLING = 0x200;
/**
* URI scheme for telephone number URIs.
*/
public static final String SCHEME_TEL = "tel";
/**
* URI scheme for voicemail URIs.
*/
public static final String SCHEME_VOICEMAIL = "voicemail";
/**
* URI scheme for SIP URIs.
*/
public static final String SCHEME_SIP = "sip";
/**
* Indicating no icon tint is set.
* @hide
*/
public static final int NO_ICON_TINT = 0;
/**
* Indicating no hightlight color is set.
*/
public static final int NO_HIGHLIGHT_COLOR = 0;
/**
* Indicating no resource ID is set.
*/
public static final int NO_RESOURCE_ID = -1;
private final PhoneAccountHandle mAccountHandle;
private final Uri mAddress;
private final Uri mSubscriptionAddress;
private final int mCapabilities;
private final int mHighlightColor;
private final CharSequence mLabel;
private final CharSequence mShortDescription;
private final List
* {@code PhoneAccount}s only support extra values of type: {@link String}, {@link Integer},
* and {@link Boolean}. Extras which are not of these types are ignored.
*
* @param extras
* @return
*/
public Builder setExtras(Bundle extras) {
mExtras = extras;
return this;
}
/**
* Sets the enabled state of the phone account.
*
* @param isEnabled The enabled state.
* @return The builder.
* @hide
*/
public Builder setIsEnabled(boolean isEnabled) {
mIsEnabled = isEnabled;
return this;
}
/**
* Sets the group Id of the {@link PhoneAccount}. When a new {@link PhoneAccount} is
* registered to Telecom, it will replace another {@link PhoneAccount} that is already
* registered in Telecom and take on the current user defaults and enabled status. There can
* only be one {@link PhoneAccount} with a non-empty group number registered to Telecom at a
* time. By default, there is no group Id for a {@link PhoneAccount} (an empty String). Only
* grouped {@link PhoneAccount}s with the same {@link ConnectionService} can be replaced.
* @param groupId The group Id of the {@link PhoneAccount} that will replace any other
* registered {@link PhoneAccount} in Telecom with the same Group Id.
* @return The builder
* @hide
*/
public Builder setGroupId(String groupId) {
if (groupId != null) {
mGroupId = groupId;
} else {
mGroupId = "";
}
return this;
}
/**
* Creates an instance of a {@link PhoneAccount} based on the current builder settings.
*
* @return The {@link PhoneAccount}.
*/
public PhoneAccount build() {
// If no supported URI schemes were defined, assume "tel" is supported.
if (mSupportedUriSchemes.isEmpty()) {
addSupportedUriScheme(SCHEME_TEL);
}
return new PhoneAccount(
mAccountHandle,
mAddress,
mSubscriptionAddress,
mCapabilities,
mIcon,
mHighlightColor,
mLabel,
mShortDescription,
mSupportedUriSchemes,
mExtras,
mIsEnabled,
mGroupId);
}
}
private PhoneAccount(
PhoneAccountHandle account,
Uri address,
Uri subscriptionAddress,
int capabilities,
Icon icon,
int highlightColor,
CharSequence label,
CharSequence shortDescription,
List
*
* @return The subscription number, suitable for display to the user.
*/
public Uri getSubscriptionAddress() {
return mSubscriptionAddress;
}
/**
* The capabilities of this {@code PhoneAccount}.
*
* @return A bit field of flags describing this {@code PhoneAccount}'s capabilities.
*/
public int getCapabilities() {
return mCapabilities;
}
/**
* Determines if this {@code PhoneAccount} has a capabilities specified by the passed in
* bit mask.
*
* @param capability The capabilities to check.
* @return {@code true} if the phone account has the capability.
*/
public boolean hasCapabilities(int capability) {
return (mCapabilities & capability) == capability;
}
/**
* A short label describing a {@code PhoneAccount}.
*
* @return A label for this {@code PhoneAccount}.
*/
public CharSequence getLabel() {
return mLabel;
}
/**
* A short paragraph describing this {@code PhoneAccount}.
*
* @return A description for this {@code PhoneAccount}.
*/
public CharSequence getShortDescription() {
return mShortDescription;
}
/**
* The URI schemes supported by this {@code PhoneAccount}.
*
* @return The URI schemes.
*/
public List
* A {@link ConnectionService} may provide implementation specific information about the
* {@link PhoneAccount} via the extras.
*
* @return The extras.
*/
public Bundle getExtras() {
return mExtras;
}
/**
* The icon to represent this {@code PhoneAccount}.
*
* @return The icon.
*/
public Icon getIcon() {
return mIcon;
}
/**
* Indicates whether the user has enabled this {@code PhoneAccount} or not. This value is only
* populated for {@code PhoneAccount}s returned by {@link TelecomManager#getPhoneAccount}.
*
* @return {@code true} if the account is enabled by the user, {@code false} otherwise.
*/
public boolean isEnabled() {
return mIsEnabled;
}
/**
* A non-empty {@link String} representing the group that A {@link PhoneAccount} is in or an
* empty {@link String} if the {@link PhoneAccount} is not in a group. If this
* {@link PhoneAccount} is in a group, this new {@link PhoneAccount} will replace a registered
* {@link PhoneAccount} that is in the same group. When the {@link PhoneAccount} is replaced,
* its user defined defaults and enabled status will also pass to this new {@link PhoneAccount}.
* Only {@link PhoneAccount}s that share the same {@link ConnectionService} can be replaced.
*
* @return A non-empty String Id if this {@link PhoneAccount} belongs to a group.
* @hide
*/
public String getGroupId() {
return mGroupId;
}
/**
* Determines if the {@link PhoneAccount} supports calls to/from addresses with a specified URI
* scheme.
*
* @param uriScheme The URI scheme to check.
* @return {@code true} if the {@code PhoneAccount} supports calls to/from addresses with the
* specified URI scheme.
*/
public boolean supportsUriScheme(String uriScheme) {
if (mSupportedUriSchemes == null || uriScheme == null) {
return false;
}
for (String scheme : mSupportedUriSchemes) {
if (scheme != null && scheme.equals(uriScheme)) {
return true;
}
}
return false;
}
/**
* A highlight color to use in displaying information about this {@code PhoneAccount}.
*
* @return A hexadecimal color value.
*/
public int getHighlightColor() {
return mHighlightColor;
}
/**
* Sets the enabled state of the phone account.
* @hide
*/
public void setIsEnabled(boolean isEnabled) {
mIsEnabled = isEnabled;
}
//
// Parcelable implementation
//
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(Parcel out, int flags) {
if (mAccountHandle == null) {
out.writeInt(0);
} else {
out.writeInt(1);
mAccountHandle.writeToParcel(out, flags);
}
if (mAddress == null) {
out.writeInt(0);
} else {
out.writeInt(1);
mAddress.writeToParcel(out, flags);
}
if (mSubscriptionAddress == null) {
out.writeInt(0);
} else {
out.writeInt(1);
mSubscriptionAddress.writeToParcel(out, flags);
}
out.writeInt(mCapabilities);
out.writeInt(mHighlightColor);
out.writeCharSequence(mLabel);
out.writeCharSequence(mShortDescription);
out.writeStringList(mSupportedUriSchemes);
if (mIcon == null) {
out.writeInt(0);
} else {
out.writeInt(1);
mIcon.writeToParcel(out, flags);
}
out.writeByte((byte) (mIsEnabled ? 1 : 0));
out.writeBundle(mExtras);
out.writeString(mGroupId);
}
public static final Creator