| /* |
| * Copyright (C) 2016 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.app; |
| |
| import android.annotation.FlaggedApi; |
| import android.annotation.NonNull; |
| import android.annotation.Nullable; |
| import android.annotation.SystemApi; |
| import android.annotation.TestApi; |
| import android.app.NotificationManager.Importance; |
| import android.compat.annotation.UnsupportedAppUsage; |
| import android.content.ContentResolver; |
| import android.content.Context; |
| import android.content.Intent; |
| import android.content.pm.ShortcutInfo; |
| import android.media.AudioAttributes; |
| import android.media.RingtoneManager; |
| import android.net.Uri; |
| import android.os.Parcel; |
| import android.os.Parcelable; |
| import android.os.VibrationEffect; |
| import android.os.vibrator.persistence.VibrationXmlParser; |
| import android.os.vibrator.persistence.VibrationXmlSerializer; |
| import android.provider.Settings; |
| import android.service.notification.NotificationListenerService; |
| import android.text.TextUtils; |
| import android.util.Log; |
| import android.util.proto.ProtoOutputStream; |
| |
| import com.android.internal.util.Preconditions; |
| import com.android.internal.util.XmlUtils; |
| import com.android.modules.utils.TypedXmlPullParser; |
| import com.android.modules.utils.TypedXmlSerializer; |
| |
| import org.json.JSONException; |
| import org.json.JSONObject; |
| import org.xmlpull.v1.XmlPullParser; |
| import org.xmlpull.v1.XmlSerializer; |
| |
| import java.io.FileNotFoundException; |
| import java.io.IOException; |
| import java.io.PrintWriter; |
| import java.io.StringReader; |
| import java.io.StringWriter; |
| import java.util.Arrays; |
| import java.util.Objects; |
| |
| /** |
| * A representation of settings that apply to a collection of similarly themed notifications. |
| */ |
| public final class NotificationChannel implements Parcelable { |
| private static final String TAG = "NotificationChannel"; |
| |
| /** |
| * The id of the default channel for an app. This id is reserved by the system. All |
| * notifications posted from apps targeting {@link android.os.Build.VERSION_CODES#N_MR1} or |
| * earlier without a notification channel specified are posted to this channel. |
| */ |
| public static final String DEFAULT_CHANNEL_ID = "miscellaneous"; |
| |
| /** |
| * The formatter used by the system to create an id for notification |
| * channels when it automatically creates conversation channels on behalf of an app. The format |
| * string takes two arguments, in this order: the |
| * {@link #getId()} of the original notification channel, and the |
| * {@link ShortcutInfo#getId() id} of the conversation. |
| * @hide |
| */ |
| public static final String CONVERSATION_CHANNEL_ID_FORMAT = "%1$s : %2$s"; |
| |
| /** |
| * TODO: STOPSHIP remove |
| * Conversation id to use for apps that aren't providing them yet. |
| * @hide |
| */ |
| public static final String PLACEHOLDER_CONVERSATION_ID = ":placeholder_id"; |
| |
| /** |
| * Extra value for {@link Settings#EXTRA_CHANNEL_FILTER_LIST}. Include to show fields |
| * that have to do with editing sound, like a tone picker |
| * ({@link #setSound(Uri, AudioAttributes)}). |
| */ |
| public static final String EDIT_SOUND = "sound"; |
| /** |
| * Extra value for {@link Settings#EXTRA_CHANNEL_FILTER_LIST}. Include to show fields |
| * that have to do with editing vibration ({@link #enableVibration(boolean)}, |
| * {@link #setVibrationPattern(long[])}). |
| */ |
| public static final String EDIT_VIBRATION = "vibration"; |
| /** |
| * Extra value for {@link Settings#EXTRA_CHANNEL_FILTER_LIST}. Include to show fields |
| * that have to do with editing importance ({@link #setImportance(int)}) and/or conversation |
| * priority. |
| */ |
| public static final String EDIT_IMPORTANCE = "importance"; |
| /** |
| * Extra value for {@link Settings#EXTRA_CHANNEL_FILTER_LIST}. Include to show fields |
| * that have to do with editing behavior on devices that are locked or have a turned off |
| * display ({@link #setLockscreenVisibility(int)}, {@link #enableLights(boolean)}, |
| * {@link #setLightColor(int)}). |
| */ |
| public static final String EDIT_LOCKED_DEVICE = "locked"; |
| /** |
| * Extra value for {@link Settings#EXTRA_CHANNEL_FILTER_LIST}. Include to show fields |
| * that have to do with editing do not disturb bypass {(@link #setBypassDnd(boolean)}) . |
| */ |
| public static final String EDIT_ZEN = "zen"; |
| /** |
| * Extra value for {@link Settings#EXTRA_CHANNEL_FILTER_LIST}. Include to show fields |
| * that have to do with editing conversation settings (demoting or restoring a channel to |
| * be a Conversation, changing bubble behavior, or setting the priority of a conversation). |
| */ |
| public static final String EDIT_CONVERSATION = "conversation"; |
| /** |
| * Extra value for {@link Settings#EXTRA_CHANNEL_FILTER_LIST}. Include to show fields |
| * that have to do with editing launcher behavior (showing badges)}. |
| */ |
| public static final String EDIT_LAUNCHER = "launcher"; |
| |
| /** |
| * The maximum length for text fields in a NotificationChannel. Fields will be truncated at this |
| * limit. |
| * @hide |
| */ |
| public static final int MAX_TEXT_LENGTH = 1000; |
| /** |
| * @hide |
| */ |
| public static final int MAX_VIBRATION_LENGTH = 1000; |
| |
| private static final String TAG_CHANNEL = "channel"; |
| private static final String ATT_NAME = "name"; |
| private static final String ATT_DESC = "desc"; |
| private static final String ATT_ID = "id"; |
| private static final String ATT_DELETED = "deleted"; |
| private static final String ATT_PRIORITY = "priority"; |
| private static final String ATT_VISIBILITY = "visibility"; |
| private static final String ATT_IMPORTANCE = "importance"; |
| private static final String ATT_LIGHTS = "lights"; |
| private static final String ATT_LIGHT_COLOR = "light_color"; |
| private static final String ATT_VIBRATION = "vibration"; |
| private static final String ATT_VIBRATION_EFFECT = "vibration_effect"; |
| private static final String ATT_VIBRATION_ENABLED = "vibration_enabled"; |
| private static final String ATT_SOUND = "sound"; |
| private static final String ATT_USAGE = "usage"; |
| private static final String ATT_FLAGS = "flags"; |
| private static final String ATT_CONTENT_TYPE = "content_type"; |
| private static final String ATT_SHOW_BADGE = "show_badge"; |
| private static final String ATT_USER_LOCKED = "locked"; |
| /** |
| * This attribute represents both foreground services and user initiated jobs in U+. |
| * It was not renamed in U on purpose, in order to avoid creating an unnecessary migration path. |
| */ |
| private static final String ATT_FG_SERVICE_SHOWN = "fgservice"; |
| private static final String ATT_GROUP = "group"; |
| private static final String ATT_BLOCKABLE_SYSTEM = "blockable_system"; |
| private static final String ATT_ALLOW_BUBBLE = "allow_bubbles"; |
| private static final String ATT_ORIG_IMP = "orig_imp"; |
| private static final String ATT_PARENT_CHANNEL = "parent"; |
| private static final String ATT_CONVERSATION_ID = "conv_id"; |
| private static final String ATT_IMP_CONVERSATION = "imp_conv"; |
| private static final String ATT_DEMOTE = "dem"; |
| private static final String ATT_DELETED_TIME_MS = "del_time"; |
| private static final String DELIMITER = ","; |
| |
| /** |
| * @hide |
| */ |
| public static final int USER_LOCKED_PRIORITY = 0x00000001; |
| /** |
| * @hide |
| */ |
| public static final int USER_LOCKED_VISIBILITY = 0x00000002; |
| /** |
| * @hide |
| */ |
| public static final int USER_LOCKED_IMPORTANCE = 0x00000004; |
| /** |
| * @hide |
| */ |
| public static final int USER_LOCKED_LIGHTS = 0x00000008; |
| /** |
| * @hide |
| */ |
| public static final int USER_LOCKED_VIBRATION = 0x00000010; |
| /** |
| * @hide |
| */ |
| @SystemApi |
| public static final int USER_LOCKED_SOUND = 0x00000020; |
| |
| /** |
| * @hide |
| */ |
| public static final int USER_LOCKED_SHOW_BADGE = 0x00000080; |
| |
| /** |
| * @hide |
| */ |
| public static final int USER_LOCKED_ALLOW_BUBBLE = 0x00000100; |
| |
| /** |
| * @hide |
| */ |
| public static final int[] LOCKABLE_FIELDS = new int[] { |
| USER_LOCKED_PRIORITY, |
| USER_LOCKED_VISIBILITY, |
| USER_LOCKED_IMPORTANCE, |
| USER_LOCKED_LIGHTS, |
| USER_LOCKED_VIBRATION, |
| USER_LOCKED_SOUND, |
| USER_LOCKED_SHOW_BADGE, |
| USER_LOCKED_ALLOW_BUBBLE |
| }; |
| |
| /** |
| * @hide |
| */ |
| public static final int DEFAULT_ALLOW_BUBBLE = -1; |
| /** |
| * @hide |
| */ |
| public static final int ALLOW_BUBBLE_ON = 1; |
| /** |
| * @hide |
| */ |
| public static final int ALLOW_BUBBLE_OFF = 0; |
| |
| private static final int DEFAULT_LIGHT_COLOR = 0; |
| private static final int DEFAULT_VISIBILITY = |
| NotificationManager.VISIBILITY_NO_OVERRIDE; |
| private static final int DEFAULT_IMPORTANCE = |
| NotificationManager.IMPORTANCE_UNSPECIFIED; |
| private static final boolean DEFAULT_DELETED = false; |
| private static final boolean DEFAULT_SHOW_BADGE = true; |
| private static final long DEFAULT_DELETION_TIME_MS = -1; |
| |
| @UnsupportedAppUsage |
| private String mId; |
| private String mName; |
| private String mDesc; |
| private int mImportance = DEFAULT_IMPORTANCE; |
| private int mOriginalImportance = DEFAULT_IMPORTANCE; |
| private boolean mBypassDnd; |
| private int mLockscreenVisibility = DEFAULT_VISIBILITY; |
| private Uri mSound = Settings.System.DEFAULT_NOTIFICATION_URI; |
| private boolean mSoundRestored = false; |
| private boolean mLights; |
| private int mLightColor = DEFAULT_LIGHT_COLOR; |
| private long[] mVibrationPattern; |
| private VibrationEffect mVibrationEffect; |
| // Bitwise representation of fields that have been changed by the user, preventing the app from |
| // making changes to these fields. |
| private int mUserLockedFields; |
| private boolean mUserVisibleTaskShown; |
| private boolean mVibrationEnabled; |
| private boolean mShowBadge = DEFAULT_SHOW_BADGE; |
| private boolean mDeleted = DEFAULT_DELETED; |
| private String mGroup; |
| private AudioAttributes mAudioAttributes = Notification.AUDIO_ATTRIBUTES_DEFAULT; |
| // If this is a blockable system notification channel. |
| private boolean mBlockableSystem = false; |
| private int mAllowBubbles = DEFAULT_ALLOW_BUBBLE; |
| private boolean mImportanceLockedDefaultApp; |
| private String mParentId = null; |
| private String mConversationId = null; |
| private boolean mDemoted = false; |
| private boolean mImportantConvo = false; |
| private long mDeletedTime = DEFAULT_DELETION_TIME_MS; |
| /** Do not (de)serialize this value: it only affects logic in system_server and that logic |
| * is reset on each boot {@link NotificationAttentionHelper#buzzBeepBlinkLocked}. |
| */ |
| private long mLastNotificationUpdateTimeMs = 0; |
| |
| /** |
| * Creates a notification channel. |
| * |
| * @param id The id of the channel. Must be unique per package. The value may be truncated if |
| * it is too long. |
| * @param name The user visible name of the channel. You can rename this channel when the system |
| * locale changes by listening for the {@link Intent#ACTION_LOCALE_CHANGED} |
| * broadcast. The recommended maximum length is 40 characters; the value may be |
| * truncated if it is too long. |
| * @param importance The importance of the channel. This controls how interruptive notifications |
| * posted to this channel are. |
| */ |
| public NotificationChannel(String id, CharSequence name, @Importance int importance) { |
| this.mId = getTrimmedString(id); |
| this.mName = name != null ? getTrimmedString(name.toString()) : null; |
| this.mImportance = importance; |
| } |
| |
| /** |
| * @hide |
| */ |
| protected NotificationChannel(Parcel in) { |
| if (in.readByte() != 0) { |
| mId = getTrimmedString(in.readString()); |
| } else { |
| mId = null; |
| } |
| if (in.readByte() != 0) { |
| mName = getTrimmedString(in.readString()); |
| } else { |
| mName = null; |
| } |
| if (in.readByte() != 0) { |
| mDesc = getTrimmedString(in.readString()); |
| } else { |
| mDesc = null; |
| } |
| mImportance = in.readInt(); |
| mBypassDnd = in.readByte() != 0; |
| mLockscreenVisibility = in.readInt(); |
| if (in.readByte() != 0) { |
| mSound = Uri.CREATOR.createFromParcel(in); |
| mSound = Uri.parse(getTrimmedString(mSound.toString())); |
| } else { |
| mSound = null; |
| } |
| mLights = in.readByte() != 0; |
| mVibrationPattern = in.createLongArray(); |
| if (mVibrationPattern != null && mVibrationPattern.length > MAX_VIBRATION_LENGTH) { |
| mVibrationPattern = Arrays.copyOf(mVibrationPattern, MAX_VIBRATION_LENGTH); |
| } |
| if (Flags.notificationChannelVibrationEffectApi()) { |
| mVibrationEffect = |
| in.readInt() != 0 ? VibrationEffect.CREATOR.createFromParcel(in) : null; |
| } |
| mUserLockedFields = in.readInt(); |
| mUserVisibleTaskShown = in.readByte() != 0; |
| mVibrationEnabled = in.readByte() != 0; |
| mShowBadge = in.readByte() != 0; |
| mDeleted = in.readByte() != 0; |
| if (in.readByte() != 0) { |
| mGroup = getTrimmedString(in.readString()); |
| } else { |
| mGroup = null; |
| } |
| mAudioAttributes = in.readInt() > 0 ? AudioAttributes.CREATOR.createFromParcel(in) : null; |
| mLightColor = in.readInt(); |
| mBlockableSystem = in.readBoolean(); |
| mAllowBubbles = in.readInt(); |
| mOriginalImportance = in.readInt(); |
| mParentId = getTrimmedString(in.readString()); |
| mConversationId = getTrimmedString(in.readString()); |
| mDemoted = in.readBoolean(); |
| mImportantConvo = in.readBoolean(); |
| mDeletedTime = in.readLong(); |
| mImportanceLockedDefaultApp = in.readBoolean(); |
| } |
| |
| @Override |
| public void writeToParcel(Parcel dest, int flags) { |
| if (mId != null) { |
| dest.writeByte((byte) 1); |
| dest.writeString(mId); |
| } else { |
| dest.writeByte((byte) 0); |
| } |
| if (mName != null) { |
| dest.writeByte((byte) 1); |
| dest.writeString(mName); |
| } else { |
| dest.writeByte((byte) 0); |
| } |
| if (mDesc != null) { |
| dest.writeByte((byte) 1); |
| dest.writeString(mDesc); |
| } else { |
| dest.writeByte((byte) 0); |
| } |
| dest.writeInt(mImportance); |
| dest.writeByte(mBypassDnd ? (byte) 1 : (byte) 0); |
| dest.writeInt(mLockscreenVisibility); |
| if (mSound != null) { |
| dest.writeByte((byte) 1); |
| mSound.writeToParcel(dest, 0); |
| } else { |
| dest.writeByte((byte) 0); |
| } |
| dest.writeByte(mLights ? (byte) 1 : (byte) 0); |
| dest.writeLongArray(mVibrationPattern); |
| if (Flags.notificationChannelVibrationEffectApi()) { |
| if (mVibrationEffect != null) { |
| dest.writeInt(1); |
| mVibrationEffect.writeToParcel(dest, /* flags= */ 0); |
| } else { |
| dest.writeInt(0); |
| } |
| } |
| dest.writeInt(mUserLockedFields); |
| dest.writeByte(mUserVisibleTaskShown ? (byte) 1 : (byte) 0); |
| dest.writeByte(mVibrationEnabled ? (byte) 1 : (byte) 0); |
| dest.writeByte(mShowBadge ? (byte) 1 : (byte) 0); |
| dest.writeByte(mDeleted ? (byte) 1 : (byte) 0); |
| if (mGroup != null) { |
| dest.writeByte((byte) 1); |
| dest.writeString(mGroup); |
| } else { |
| dest.writeByte((byte) 0); |
| } |
| if (mAudioAttributes != null) { |
| dest.writeInt(1); |
| mAudioAttributes.writeToParcel(dest, 0); |
| } else { |
| dest.writeInt(0); |
| } |
| dest.writeInt(mLightColor); |
| dest.writeBoolean(mBlockableSystem); |
| dest.writeInt(mAllowBubbles); |
| dest.writeInt(mOriginalImportance); |
| dest.writeString(mParentId); |
| dest.writeString(mConversationId); |
| dest.writeBoolean(mDemoted); |
| dest.writeBoolean(mImportantConvo); |
| dest.writeLong(mDeletedTime); |
| dest.writeBoolean(mImportanceLockedDefaultApp); |
| } |
| |
| /** |
| * @hide |
| */ |
| public NotificationChannel copy() { |
| NotificationChannel copy = new NotificationChannel(mId, mName, mImportance); |
| copy.setDescription(mDesc); |
| copy.setBypassDnd(mBypassDnd); |
| copy.setLockscreenVisibility(mLockscreenVisibility); |
| copy.setSound(mSound, mAudioAttributes); |
| copy.setLightColor(mLightColor); |
| copy.enableLights(mLights); |
| copy.setVibrationPattern(mVibrationPattern); |
| if (Flags.notificationChannelVibrationEffectApi()) { |
| copy.setVibrationEffect(mVibrationEffect); |
| } |
| copy.lockFields(mUserLockedFields); |
| copy.setUserVisibleTaskShown(mUserVisibleTaskShown); |
| copy.enableVibration(mVibrationEnabled); |
| copy.setShowBadge(mShowBadge); |
| copy.setDeleted(mDeleted); |
| copy.setGroup(mGroup); |
| copy.setBlockable(mBlockableSystem); |
| copy.setAllowBubbles(mAllowBubbles); |
| copy.setOriginalImportance(mOriginalImportance); |
| copy.setConversationId(mParentId, mConversationId); |
| copy.setDemoted(mDemoted); |
| copy.setImportantConversation(mImportantConvo); |
| copy.setDeletedTimeMs(mDeletedTime); |
| copy.setImportanceLockedByCriticalDeviceFunction(mImportanceLockedDefaultApp); |
| copy.setLastNotificationUpdateTimeMs(mLastNotificationUpdateTimeMs); |
| |
| return copy; |
| } |
| |
| /** |
| * @hide |
| */ |
| @TestApi |
| public void lockFields(int field) { |
| mUserLockedFields |= field; |
| } |
| |
| /** |
| * @hide |
| */ |
| public void unlockFields(int field) { |
| mUserLockedFields &= ~field; |
| } |
| |
| /** |
| * @hide |
| */ |
| @TestApi |
| public void setUserVisibleTaskShown(boolean shown) { |
| mUserVisibleTaskShown = shown; |
| } |
| |
| /** |
| * @hide |
| */ |
| @TestApi |
| public void setDeleted(boolean deleted) { |
| mDeleted = deleted; |
| } |
| |
| /** |
| * @hide |
| */ |
| @TestApi |
| public void setDeletedTimeMs(long time) { |
| mDeletedTime = time; |
| } |
| |
| /** |
| * @hide |
| */ |
| @TestApi |
| public void setImportantConversation(boolean importantConvo) { |
| mImportantConvo = importantConvo; |
| } |
| |
| /** |
| * Allows users to block notifications sent through this channel, if this channel belongs to |
| * a package that otherwise would have notifications "fixed" as enabled. |
| * |
| * If the channel does not belong to a package that has a fixed notification permission, this |
| * method does nothing, since such channels are blockable by default and cannot be set to be |
| * unblockable. |
| * @param blockable if {@code true}, allows users to block notifications on this channel. |
| */ |
| public void setBlockable(boolean blockable) { |
| mBlockableSystem = blockable; |
| } |
| // Modifiable by apps post channel creation |
| |
| /** |
| * Sets the user visible name of this channel. |
| * |
| * <p>The recommended maximum length is 40 characters; the value may be truncated if it is too |
| * long. |
| */ |
| public void setName(CharSequence name) { |
| mName = name != null ? getTrimmedString(name.toString()) : null; |
| } |
| |
| /** |
| * Sets the user visible description of this channel. |
| * |
| * <p>The recommended maximum length is 300 characters; the value may be truncated if it is too |
| * long. |
| */ |
| public void setDescription(String description) { |
| mDesc = getTrimmedString(description); |
| } |
| |
| private String getTrimmedString(String input) { |
| if (input != null && input.length() > MAX_TEXT_LENGTH) { |
| return input.substring(0, MAX_TEXT_LENGTH); |
| } |
| return input; |
| } |
| |
| /** |
| * @hide |
| */ |
| public void setId(String id) { |
| mId = id; |
| } |
| |
| // Modifiable by apps on channel creation. |
| |
| /** |
| * Sets what group this channel belongs to. |
| * |
| * Group information is only used for presentation, not for behavior. |
| * |
| * Only modifiable before the channel is submitted to |
| * {@link NotificationManager#createNotificationChannel(NotificationChannel)}, unless the |
| * channel is not currently part of a group. |
| * |
| * @param groupId the id of a group created by |
| * {@link NotificationManager#createNotificationChannelGroup(NotificationChannelGroup)}. |
| */ |
| public void setGroup(String groupId) { |
| this.mGroup = groupId; |
| } |
| |
| /** |
| * Sets whether notifications posted to this channel can appear as application icon badges |
| * in a Launcher. |
| * |
| * Only modifiable before the channel is submitted to |
| * {@link NotificationManager#createNotificationChannel(NotificationChannel)}. |
| * |
| * @param showBadge true if badges should be allowed to be shown. |
| */ |
| public void setShowBadge(boolean showBadge) { |
| this.mShowBadge = showBadge; |
| } |
| |
| /** |
| * Sets the sound that should be played for notifications posted to this channel and its |
| * audio attributes. Notification channels with an {@link #getImportance() importance} of at |
| * least {@link NotificationManager#IMPORTANCE_DEFAULT} should have a sound. |
| * |
| * Note: An app-specific sound can be provided in the Uri parameter, but because channels are |
| * persistent for the duration of the app install, and are backed up and restored, the Uri |
| * should be stable. For this reason it is not recommended to use a |
| * {@link ContentResolver#SCHEME_ANDROID_RESOURCE} uri, as resource ids can change on app |
| * upgrade. |
| * |
| * Only modifiable before the channel is submitted to |
| * {@link NotificationManager#createNotificationChannel(NotificationChannel)}. |
| */ |
| public void setSound(Uri sound, AudioAttributes audioAttributes) { |
| this.mSound = sound; |
| this.mAudioAttributes = audioAttributes; |
| } |
| |
| /** |
| * Sets whether notifications posted to this channel should display notification lights, |
| * on devices that support that feature. |
| * |
| * Only modifiable before the channel is submitted to |
| * {@link NotificationManager#createNotificationChannel(NotificationChannel)}. |
| */ |
| public void enableLights(boolean lights) { |
| this.mLights = lights; |
| } |
| |
| /** |
| * Sets the notification light color for notifications posted to this channel, if lights are |
| * {@link #enableLights(boolean) enabled} on this channel and the device supports that feature. |
| * |
| * Only modifiable before the channel is submitted to |
| * {@link NotificationManager#createNotificationChannel(NotificationChannel)}. |
| */ |
| public void setLightColor(int argb) { |
| this.mLightColor = argb; |
| } |
| |
| /** |
| * Sets whether notification posted to this channel should vibrate. The vibration pattern can |
| * be set with {@link #setVibrationPattern(long[])}. |
| * |
| * Only modifiable before the channel is submitted to |
| * {@link NotificationManager#createNotificationChannel(NotificationChannel)}. |
| */ |
| public void enableVibration(boolean vibration) { |
| this.mVibrationEnabled = vibration; |
| } |
| |
| /** |
| * Sets the vibration pattern for notifications posted to this channel. If the provided |
| * pattern is valid (non-null, non-empty with at least 1 non-zero value), will enable vibration |
| * on this channel (equivalent to calling {@link #enableVibration(boolean)} with {@code true}). |
| * Otherwise, vibration will be disabled unless {@link #enableVibration(boolean)} is |
| * used with {@code true}, in which case the default vibration will be used. |
| * |
| * Only modifiable before the channel is submitted to |
| * {@link NotificationManager#createNotificationChannel(NotificationChannel)}. |
| */ |
| public void setVibrationPattern(long[] vibrationPattern) { |
| this.mVibrationEnabled = vibrationPattern != null && vibrationPattern.length > 0; |
| this.mVibrationPattern = vibrationPattern; |
| if (Flags.notificationChannelVibrationEffectApi()) { |
| try { |
| this.mVibrationEffect = |
| VibrationEffect.createWaveform(vibrationPattern, /* repeat= */ -1); |
| } catch (IllegalArgumentException | NullPointerException e) { |
| this.mVibrationEffect = null; |
| } |
| } |
| } |
| |
| /** |
| * Sets a {@link VibrationEffect} for notifications posted to this channel. If the |
| * provided effect is non-null, will enable vibration on this channel (equivalent |
| * to calling {@link #enableVibration(boolean)} with {@code true}). Otherwise |
| * vibration will be disabled unless {@link #enableVibration(boolean)} is used with |
| * {@code true}, in which case the default vibration will be used. |
| * |
| * <p>The effect passed here will be returned from {@link #getVibrationEffect()}. |
| * If the provided {@link VibrationEffect} is an equivalent to a wave-form |
| * vibration pattern, the equivalent wave-form pattern will be returned from |
| * {@link #getVibrationPattern()}. |
| * |
| * <p>Note that some {@link VibrationEffect}s may not be playable on some devices. |
| * In cases where such an effect is passed here, vibration will still be enabled |
| * for the channel, but the default vibration will be used. Nonetheless, the |
| * provided effect will be stored and be returned from {@link #getVibrationEffect} |
| * calls, and could be used by the same channel on a different device, for example, |
| * in cases the user backs up and restores to a device that does have the ability |
| * to play the effect, where that effect will be used instead of the default. To |
| * avoid such issues that could make the vibration behavior of your notification |
| * channel differ among different devices, it's recommended that you avoid |
| * vibration effect primitives, as the support for them differs widely among |
| * devices (read {@link VibrationEffect.Composition} for more on vibration |
| * primitives). |
| * |
| * <p>Only modifiable before the channel is submitted to |
| * {@link NotificationManager#createNotificationChannel(NotificationChannel)}. |
| * |
| * @see #getVibrationEffect() |
| * @see Vibrator#areEffectsSupported(int...) |
| * @see Vibrator#arePrimitivesSupported(int...) |
| */ |
| @FlaggedApi(Flags.FLAG_NOTIFICATION_CHANNEL_VIBRATION_EFFECT_API) |
| public void setVibrationEffect(@Nullable VibrationEffect effect) { |
| this.mVibrationEnabled = effect != null; |
| this.mVibrationEffect = effect; |
| this.mVibrationPattern = |
| effect == null |
| ? null : effect.computeCreateWaveformOffOnTimingsOrNull(); |
| } |
| |
| /** |
| * Sets the level of interruption of this notification channel. |
| * |
| * Only modifiable before the channel is submitted to |
| * {@link NotificationManager#createNotificationChannel(NotificationChannel)}. |
| * |
| * @param importance the amount the user should be interrupted by |
| * notifications from this channel. |
| */ |
| public void setImportance(@Importance int importance) { |
| this.mImportance = importance; |
| } |
| |
| // Modifiable by a notification ranker. |
| |
| /** |
| * Sets whether or not notifications posted to this channel can interrupt the user in |
| * {@link android.app.NotificationManager.Policy#INTERRUPTION_FILTER_PRIORITY} mode. |
| * |
| * Only modifiable by the system and notification ranker. |
| */ |
| public void setBypassDnd(boolean bypassDnd) { |
| this.mBypassDnd = bypassDnd; |
| } |
| |
| /** |
| * Sets whether notifications posted to this channel appear on the lockscreen or not, and if so, |
| * whether they appear in a redacted form. See e.g. {@link Notification#VISIBILITY_SECRET}. |
| * |
| * Only modifiable by the system and notification ranker. |
| */ |
| public void setLockscreenVisibility(int lockscreenVisibility) { |
| this.mLockscreenVisibility = lockscreenVisibility; |
| } |
| |
| /** |
| * As of Android 11 this value is no longer respected. |
| * @see #canBubble() |
| * @see Notification#getBubbleMetadata() |
| */ |
| public void setAllowBubbles(boolean allowBubbles) { |
| mAllowBubbles = allowBubbles ? ALLOW_BUBBLE_ON : ALLOW_BUBBLE_OFF; |
| } |
| |
| /** |
| * @hide |
| */ |
| public void setAllowBubbles(int allowed) { |
| mAllowBubbles = allowed; |
| } |
| |
| /** |
| * Sets this channel as being converastion-centric. Different settings and functionality may be |
| * exposed for conversation-centric channels. |
| * |
| * @param parentChannelId The {@link #getId()} id} of the generic channel that notifications of |
| * this type would be posted to in absence of a specific conversation id. |
| * For example, if this channel represents 'Messages from Person A', the |
| * parent channel would be 'Messages.' |
| * @param conversationId The {@link ShortcutInfo#getId()} of the shortcut representing this |
| * channel's conversation. |
| */ |
| public void setConversationId(@NonNull String parentChannelId, |
| @NonNull String conversationId) { |
| mParentId = parentChannelId; |
| mConversationId = conversationId; |
| } |
| |
| /** |
| * Returns the id of this channel. |
| */ |
| public String getId() { |
| return mId; |
| } |
| |
| /** |
| * Returns the user visible name of this channel. |
| */ |
| public CharSequence getName() { |
| return mName; |
| } |
| |
| /** |
| * Returns the user visible description of this channel. |
| */ |
| public String getDescription() { |
| return mDesc; |
| } |
| |
| /** |
| * Returns the user specified importance e.g. {@link NotificationManager#IMPORTANCE_LOW} for |
| * notifications posted to this channel. Note: This value might be > |
| * {@link NotificationManager#IMPORTANCE_NONE}, but notifications posted to this channel will |
| * not be shown to the user if the parent {@link NotificationChannelGroup} or app is blocked. |
| * See {@link NotificationChannelGroup#isBlocked()} and |
| * {@link NotificationManager#areNotificationsEnabled()}. |
| */ |
| public int getImportance() { |
| return mImportance; |
| } |
| |
| /** |
| * Whether or not notifications posted to this channel can bypass the Do Not Disturb |
| * {@link NotificationManager#INTERRUPTION_FILTER_PRIORITY} mode when the active policy allows |
| * priority channels to bypass notification filtering. |
| */ |
| public boolean canBypassDnd() { |
| return mBypassDnd; |
| } |
| |
| /** |
| * Whether or not this channel represents a conversation. |
| */ |
| public boolean isConversation() { |
| return !TextUtils.isEmpty(getConversationId()); |
| } |
| |
| |
| /** |
| * Whether or not notifications in this conversation are considered important. |
| * |
| * <p>Important conversations may get special visual treatment, and might be able to bypass DND. |
| * |
| * <p>This is only valid for channels that represent conversations, that is, |
| * where {@link #isConversation()} is true. |
| */ |
| public boolean isImportantConversation() { |
| return mImportantConvo; |
| } |
| |
| /** |
| * Returns the notification sound for this channel. |
| */ |
| public Uri getSound() { |
| return mSound; |
| } |
| |
| /** |
| * Returns the audio attributes for sound played by notifications posted to this channel. |
| */ |
| public AudioAttributes getAudioAttributes() { |
| return mAudioAttributes; |
| } |
| |
| /** |
| * Returns whether notifications posted to this channel trigger notification lights. |
| */ |
| public boolean shouldShowLights() { |
| return mLights; |
| } |
| |
| /** |
| * Returns the notification light color for notifications posted to this channel. Irrelevant |
| * unless {@link #shouldShowLights()}. |
| */ |
| public int getLightColor() { |
| return mLightColor; |
| } |
| |
| /** |
| * Returns whether notifications posted to this channel always vibrate. |
| */ |
| public boolean shouldVibrate() { |
| return mVibrationEnabled; |
| } |
| |
| /** |
| * Returns the vibration pattern for notifications posted to this channel. Will be ignored if |
| * vibration is not enabled ({@link #shouldVibrate()}). |
| */ |
| public long[] getVibrationPattern() { |
| return mVibrationPattern; |
| } |
| |
| /** |
| * Returns the {@link VibrationEffect} for notifications posted to this channel. |
| * The returned effect is derived from either the effect provided in the |
| * {@link #setVibrationEffect(VibrationEffect)} method, or the equivalent vibration effect |
| * of the pattern set via the {@link #setVibrationPattern(long[])} method, based on setter |
| * method that was called last. |
| * |
| * The returned effect will be ignored in one of the following cases: |
| * <ul> |
| * <li> vibration is not enabled for the channel (i.e. {@link #shouldVibrate()} |
| * returns {@code false}). |
| * <li> the effect is not supported/playable by the device. In this case, if |
| * vibration is enabled for the channel, the default channel vibration will |
| * be used instead. |
| * </ul> |
| * |
| * @return the {@link VibrationEffect} set via {@link |
| * #setVibrationEffect(VibrationEffect)}, or the equivalent of the |
| * vibration set via {@link #setVibrationPattern(long[])}. |
| * |
| * @see VibrationEffect#createWaveform(long[], int) |
| */ |
| @FlaggedApi(Flags.FLAG_NOTIFICATION_CHANNEL_VIBRATION_EFFECT_API) |
| @Nullable |
| public VibrationEffect getVibrationEffect() { |
| return mVibrationEffect; |
| } |
| |
| /** |
| * Returns whether or not notifications posted to this channel are shown on the lockscreen in |
| * full or redacted form. |
| */ |
| public int getLockscreenVisibility() { |
| return mLockscreenVisibility; |
| } |
| |
| /** |
| * Returns whether notifications posted to this channel can appear as badges in a Launcher |
| * application. |
| * |
| * Note that badging may be disabled for other reasons. |
| */ |
| public boolean canShowBadge() { |
| return mShowBadge; |
| } |
| |
| /** |
| * Returns what group this channel belongs to. |
| * |
| * This is used only for visually grouping channels in the UI. |
| */ |
| public String getGroup() { |
| return mGroup; |
| } |
| |
| /** |
| * Returns whether notifications posted to this channel are allowed to display outside of the |
| * notification shade, in a floating window on top of other apps. |
| * |
| * @see Notification#getBubbleMetadata() |
| */ |
| public boolean canBubble() { |
| return mAllowBubbles == ALLOW_BUBBLE_ON; |
| } |
| |
| /** |
| * @hide |
| */ |
| public int getAllowBubbles() { |
| return mAllowBubbles; |
| } |
| |
| /** |
| * Returns the {@link #getId() id} of the parent notification channel to this channel, if it's |
| * a conversation related channel. See {@link #setConversationId(String, String)}. |
| */ |
| public @Nullable String getParentChannelId() { |
| return mParentId; |
| } |
| |
| /** |
| * Returns the {@link ShortcutInfo#getId() id} of the conversation backing this channel, if it's |
| * associated with a conversation. See {@link #setConversationId(String, String)}. |
| */ |
| public @Nullable String getConversationId() { |
| return mConversationId; |
| } |
| |
| /** |
| * @hide |
| */ |
| @SystemApi |
| public boolean isDeleted() { |
| return mDeleted; |
| } |
| |
| /** |
| * @hide |
| */ |
| public long getDeletedTimeMs() { |
| return mDeletedTime; |
| } |
| |
| /** |
| * @hide |
| */ |
| @SystemApi |
| public int getUserLockedFields() { |
| return mUserLockedFields; |
| } |
| |
| /** |
| * @hide |
| */ |
| public boolean isUserVisibleTaskShown() { |
| return mUserVisibleTaskShown; |
| } |
| |
| /** |
| * Returns whether this channel is always blockable, even if the app is 'fixed' as |
| * non-blockable. |
| */ |
| public boolean isBlockable() { |
| return mBlockableSystem; |
| } |
| |
| /** |
| * @hide |
| */ |
| @TestApi |
| public void setImportanceLockedByCriticalDeviceFunction(boolean locked) { |
| mImportanceLockedDefaultApp = locked; |
| } |
| |
| /** |
| * @hide |
| */ |
| @TestApi |
| public boolean isImportanceLockedByCriticalDeviceFunction() { |
| return mImportanceLockedDefaultApp; |
| } |
| |
| /** |
| * @hide |
| */ |
| @TestApi |
| public int getOriginalImportance() { |
| return mOriginalImportance; |
| } |
| |
| /** |
| * @hide |
| */ |
| @TestApi |
| public void setOriginalImportance(int importance) { |
| mOriginalImportance = importance; |
| } |
| |
| /** |
| * @hide |
| */ |
| @TestApi |
| public void setDemoted(boolean demoted) { |
| mDemoted = demoted; |
| } |
| |
| /** |
| * Returns whether the user has decided that this channel does not represent a conversation. The |
| * value will always be false for channels that never claimed to be conversations - that is, |
| * for channels where {@link #getConversationId()} and {@link #getParentChannelId()} are empty. |
| */ |
| public boolean isDemoted() { |
| return mDemoted; |
| } |
| |
| /** |
| * Returns whether the user has chosen the importance of this channel, either to affirm the |
| * initial selection from the app, or changed it to be higher or lower. |
| * @see #getImportance() |
| */ |
| public boolean hasUserSetImportance() { |
| return (mUserLockedFields & USER_LOCKED_IMPORTANCE) != 0; |
| } |
| |
| /** |
| * Returns whether the user has chosen the sound of this channel. |
| * @see #getSound() |
| */ |
| public boolean hasUserSetSound() { |
| return (mUserLockedFields & USER_LOCKED_SOUND) != 0; |
| } |
| |
| /** |
| * Returns the time of the notification post or last update for this channel. |
| * @return time of post / last update |
| * @hide |
| */ |
| public long getLastNotificationUpdateTimeMs() { |
| return mLastNotificationUpdateTimeMs; |
| } |
| |
| /** |
| * Sets the time of the notification post or last update for this channel. |
| * @hide |
| */ |
| public void setLastNotificationUpdateTimeMs(long updateTimeMs) { |
| mLastNotificationUpdateTimeMs = updateTimeMs; |
| } |
| |
| /** |
| * @hide |
| */ |
| public void populateFromXmlForRestore(XmlPullParser parser, boolean pkgInstalled, |
| Context context) { |
| populateFromXml(XmlUtils.makeTyped(parser), true, pkgInstalled, context); |
| } |
| |
| /** |
| * @hide |
| */ |
| @SystemApi |
| public void populateFromXml(XmlPullParser parser) { |
| populateFromXml(XmlUtils.makeTyped(parser), false, true, null); |
| } |
| |
| /** |
| * If {@param forRestore} is true, {@param Context} MUST be non-null. |
| */ |
| private void populateFromXml(TypedXmlPullParser parser, boolean forRestore, |
| boolean pkgInstalled, @Nullable Context context) { |
| Preconditions.checkArgument(!forRestore || context != null, |
| "forRestore is true but got null context"); |
| |
| // Name, id, and importance are set in the constructor. |
| setDescription(parser.getAttributeValue(null, ATT_DESC)); |
| setBypassDnd(Notification.PRIORITY_DEFAULT |
| != safeInt(parser, ATT_PRIORITY, Notification.PRIORITY_DEFAULT)); |
| setLockscreenVisibility(safeInt(parser, ATT_VISIBILITY, DEFAULT_VISIBILITY)); |
| |
| Uri sound = safeUri(parser, ATT_SOUND); |
| |
| final AudioAttributes audioAttributes = safeAudioAttributes(parser); |
| final int usage = audioAttributes.getUsage(); |
| setSound(forRestore ? restoreSoundUri(context, sound, pkgInstalled, usage) : sound, |
| audioAttributes); |
| |
| enableLights(safeBool(parser, ATT_LIGHTS, false)); |
| setLightColor(safeInt(parser, ATT_LIGHT_COLOR, DEFAULT_LIGHT_COLOR)); |
| // Set the pattern before the effect, so that we can properly handle cases where the pattern |
| // is null, but the effect is not null (i.e. for non-waveform VibrationEffects - the ones |
| // which cannot be represented as a vibration pattern). |
| setVibrationPattern(safeLongArray(parser, ATT_VIBRATION, null)); |
| if (Flags.notificationChannelVibrationEffectApi()) { |
| VibrationEffect vibrationEffect = safeVibrationEffect(parser, ATT_VIBRATION_EFFECT); |
| if (vibrationEffect != null) { |
| // Restore the effect only if it is not null. This allows to avoid undoing a |
| // `setVibrationPattern` call above, if that was done with a non-null pattern |
| // (e.g. back up from a version that did not support `setVibrationEffect`). |
| setVibrationEffect(vibrationEffect); |
| } |
| } |
| enableVibration(safeBool(parser, ATT_VIBRATION_ENABLED, false)); |
| setShowBadge(safeBool(parser, ATT_SHOW_BADGE, false)); |
| setDeleted(safeBool(parser, ATT_DELETED, false)); |
| setDeletedTimeMs(XmlUtils.readLongAttribute( |
| parser, ATT_DELETED_TIME_MS, DEFAULT_DELETION_TIME_MS)); |
| setGroup(parser.getAttributeValue(null, ATT_GROUP)); |
| lockFields(safeInt(parser, ATT_USER_LOCKED, 0)); |
| setUserVisibleTaskShown(safeBool(parser, ATT_FG_SERVICE_SHOWN, false)); |
| setBlockable(safeBool(parser, ATT_BLOCKABLE_SYSTEM, false)); |
| setAllowBubbles(safeInt(parser, ATT_ALLOW_BUBBLE, DEFAULT_ALLOW_BUBBLE)); |
| setOriginalImportance(safeInt(parser, ATT_ORIG_IMP, DEFAULT_IMPORTANCE)); |
| setConversationId(parser.getAttributeValue(null, ATT_PARENT_CHANNEL), |
| parser.getAttributeValue(null, ATT_CONVERSATION_ID)); |
| setDemoted(safeBool(parser, ATT_DEMOTE, false)); |
| setImportantConversation(safeBool(parser, ATT_IMP_CONVERSATION, false)); |
| } |
| |
| /** |
| * Returns whether the sound for this channel was successfully restored |
| * from backup. |
| * @return false if the sound was not restored successfully. true otherwise (default value) |
| * @hide |
| */ |
| public boolean isSoundRestored() { |
| return mSoundRestored; |
| } |
| |
| @Nullable |
| private Uri getCanonicalizedSoundUri(ContentResolver contentResolver, @NonNull Uri uri) { |
| if (Settings.System.DEFAULT_NOTIFICATION_URI.equals(uri)) { |
| return uri; |
| } |
| |
| if (ContentResolver.SCHEME_ANDROID_RESOURCE.equals(uri.getScheme())) { |
| try { |
| contentResolver.getResourceId(uri); |
| return uri; |
| } catch (FileNotFoundException e) { |
| return null; |
| } |
| } |
| |
| if (ContentResolver.SCHEME_FILE.equals(uri.getScheme())) { |
| return uri; |
| } |
| return contentResolver.canonicalize(uri); |
| } |
| |
| @Nullable |
| private Uri getUncanonicalizedSoundUri( |
| ContentResolver contentResolver, @NonNull Uri uri, int usage) { |
| if (Settings.System.DEFAULT_NOTIFICATION_URI.equals(uri) |
| || ContentResolver.SCHEME_ANDROID_RESOURCE.equals(uri.getScheme()) |
| || ContentResolver.SCHEME_FILE.equals(uri.getScheme())) { |
| return uri; |
| } |
| int ringtoneType = 0; |
| |
| // Consistent with UI(SoundPreferenceController.handlePreferenceTreeClick). |
| if (AudioAttributes.USAGE_ALARM == usage) { |
| ringtoneType = RingtoneManager.TYPE_ALARM; |
| } else if (AudioAttributes.USAGE_NOTIFICATION_RINGTONE == usage) { |
| ringtoneType = RingtoneManager.TYPE_RINGTONE; |
| } else { |
| ringtoneType = RingtoneManager.TYPE_NOTIFICATION; |
| } |
| try { |
| return RingtoneManager.getRingtoneUriForRestore( |
| contentResolver, uri.toString(), ringtoneType); |
| } catch (Exception e) { |
| Log.e(TAG, "Failed to uncanonicalized sound uri for " + uri + " " + e); |
| return Settings.System.DEFAULT_NOTIFICATION_URI; |
| } |
| } |
| |
| /** |
| * Restore/validate sound Uri from backup |
| * @param context The Context |
| * @param uri The sound Uri to restore |
| * @param pkgInstalled If the parent package is installed |
| * @return restored and validated Uri |
| * @hide |
| */ |
| @Nullable |
| public Uri restoreSoundUri( |
| Context context, @Nullable Uri uri, boolean pkgInstalled, int usage) { |
| if (uri == null || Uri.EMPTY.equals(uri)) { |
| return null; |
| } |
| ContentResolver contentResolver = context.getContentResolver(); |
| // There are backups out there with uncanonical uris (because we fixed this after |
| // shipping). If uncanonical uris are given to MediaProvider.uncanonicalize it won't |
| // verify the uri against device storage and we'll possibly end up with a broken uri. |
| // We then canonicalize the uri to uncanonicalize it back, which means we properly check |
| // the uri and in the case of not having the resource we end up with the default - better |
| // than broken. As a side effect we'll canonicalize already canonicalized uris, this is fine |
| // according to the docs because canonicalize method has to handle canonical uris as well. |
| Uri canonicalizedUri = getCanonicalizedSoundUri(contentResolver, uri); |
| if (canonicalizedUri == null) { |
| // Uri failed to restore with package installed |
| if (!mSoundRestored && pkgInstalled) { |
| mSoundRestored = true; |
| // We got a null because the uri in the backup does not exist here, so we return |
| // default |
| return Settings.System.DEFAULT_NOTIFICATION_URI; |
| } else { |
| // Flag as unrestored and try again later (on package install) |
| mSoundRestored = false; |
| return uri; |
| } |
| } |
| mSoundRestored = true; |
| return getUncanonicalizedSoundUri(contentResolver, canonicalizedUri, usage); |
| } |
| |
| /** |
| * @hide |
| */ |
| @SystemApi |
| public void writeXml(XmlSerializer out) throws IOException { |
| writeXml(XmlUtils.makeTyped(out), false, null); |
| } |
| |
| /** |
| * @hide |
| */ |
| public void writeXmlForBackup(XmlSerializer out, Context context) throws IOException { |
| writeXml(XmlUtils.makeTyped(out), true, context); |
| } |
| |
| private Uri getSoundForBackup(Context context) { |
| Uri sound = getSound(); |
| if (sound == null || Uri.EMPTY.equals(sound)) { |
| return null; |
| } |
| Uri canonicalSound = getCanonicalizedSoundUri(context.getContentResolver(), sound); |
| if (canonicalSound == null) { |
| // The content provider does not support canonical uris so we backup the default |
| return Settings.System.DEFAULT_NOTIFICATION_URI; |
| } |
| return canonicalSound; |
| } |
| |
| /** |
| * If {@param forBackup} is true, {@param Context} MUST be non-null. |
| */ |
| private void writeXml(TypedXmlSerializer out, boolean forBackup, @Nullable Context context) |
| throws IOException { |
| Preconditions.checkArgument(!forBackup || context != null, |
| "forBackup is true but got null context"); |
| out.startTag(null, TAG_CHANNEL); |
| out.attribute(null, ATT_ID, getId()); |
| if (getName() != null) { |
| out.attribute(null, ATT_NAME, getName().toString()); |
| } |
| if (getDescription() != null) { |
| out.attribute(null, ATT_DESC, getDescription()); |
| } |
| if (getImportance() != DEFAULT_IMPORTANCE) { |
| out.attributeInt(null, ATT_IMPORTANCE, getImportance()); |
| } |
| if (canBypassDnd()) { |
| out.attributeInt(null, ATT_PRIORITY, Notification.PRIORITY_MAX); |
| } |
| if (getLockscreenVisibility() != DEFAULT_VISIBILITY) { |
| out.attributeInt(null, ATT_VISIBILITY, getLockscreenVisibility()); |
| } |
| Uri sound = forBackup ? getSoundForBackup(context) : getSound(); |
| if (sound != null) { |
| out.attribute(null, ATT_SOUND, sound.toString()); |
| } |
| if (getAudioAttributes() != null) { |
| out.attributeInt(null, ATT_USAGE, getAudioAttributes().getUsage()); |
| out.attributeInt(null, ATT_CONTENT_TYPE, getAudioAttributes().getContentType()); |
| out.attributeInt(null, ATT_FLAGS, getAudioAttributes().getFlags()); |
| } |
| if (shouldShowLights()) { |
| out.attributeBoolean(null, ATT_LIGHTS, shouldShowLights()); |
| } |
| if (getLightColor() != DEFAULT_LIGHT_COLOR) { |
| out.attributeInt(null, ATT_LIGHT_COLOR, getLightColor()); |
| } |
| if (shouldVibrate()) { |
| out.attributeBoolean(null, ATT_VIBRATION_ENABLED, shouldVibrate()); |
| } |
| if (getVibrationPattern() != null) { |
| out.attribute(null, ATT_VIBRATION, longArrayToString(getVibrationPattern())); |
| } |
| if (getVibrationEffect() != null) { |
| out.attribute(null, ATT_VIBRATION_EFFECT, vibrationToString(getVibrationEffect())); |
| } |
| if (getUserLockedFields() != 0) { |
| out.attributeInt(null, ATT_USER_LOCKED, getUserLockedFields()); |
| } |
| if (isUserVisibleTaskShown()) { |
| out.attributeBoolean(null, ATT_FG_SERVICE_SHOWN, isUserVisibleTaskShown()); |
| } |
| if (canShowBadge()) { |
| out.attributeBoolean(null, ATT_SHOW_BADGE, canShowBadge()); |
| } |
| if (isDeleted()) { |
| out.attributeBoolean(null, ATT_DELETED, isDeleted()); |
| } |
| if (getDeletedTimeMs() >= 0) { |
| out.attributeLong(null, ATT_DELETED_TIME_MS, getDeletedTimeMs()); |
| } |
| if (getGroup() != null) { |
| out.attribute(null, ATT_GROUP, getGroup()); |
| } |
| if (isBlockable()) { |
| out.attributeBoolean(null, ATT_BLOCKABLE_SYSTEM, isBlockable()); |
| } |
| if (getAllowBubbles() != DEFAULT_ALLOW_BUBBLE) { |
| out.attributeInt(null, ATT_ALLOW_BUBBLE, getAllowBubbles()); |
| } |
| if (getOriginalImportance() != DEFAULT_IMPORTANCE) { |
| out.attributeInt(null, ATT_ORIG_IMP, getOriginalImportance()); |
| } |
| if (getParentChannelId() != null) { |
| out.attribute(null, ATT_PARENT_CHANNEL, getParentChannelId()); |
| } |
| if (getConversationId() != null) { |
| out.attribute(null, ATT_CONVERSATION_ID, getConversationId()); |
| } |
| if (isDemoted()) { |
| out.attributeBoolean(null, ATT_DEMOTE, isDemoted()); |
| } |
| if (isImportantConversation()) { |
| out.attributeBoolean(null, ATT_IMP_CONVERSATION, isImportantConversation()); |
| } |
| |
| // mImportanceLockedDefaultApp has a different source of truth and so isn't written to |
| // this xml file |
| |
| out.endTag(null, TAG_CHANNEL); |
| } |
| |
| /** |
| * @hide |
| */ |
| @SystemApi |
| public JSONObject toJson() throws JSONException { |
| JSONObject record = new JSONObject(); |
| record.put(ATT_ID, getId()); |
| record.put(ATT_NAME, getName()); |
| record.put(ATT_DESC, getDescription()); |
| if (getImportance() != DEFAULT_IMPORTANCE) { |
| record.put(ATT_IMPORTANCE, |
| NotificationListenerService.Ranking.importanceToString(getImportance())); |
| } |
| if (canBypassDnd()) { |
| record.put(ATT_PRIORITY, Notification.PRIORITY_MAX); |
| } |
| if (getLockscreenVisibility() != DEFAULT_VISIBILITY) { |
| record.put(ATT_VISIBILITY, Notification.visibilityToString(getLockscreenVisibility())); |
| } |
| if (getSound() != null) { |
| record.put(ATT_SOUND, getSound().toString()); |
| } |
| if (getAudioAttributes() != null) { |
| record.put(ATT_USAGE, Integer.toString(getAudioAttributes().getUsage())); |
| record.put(ATT_CONTENT_TYPE, |
| Integer.toString(getAudioAttributes().getContentType())); |
| record.put(ATT_FLAGS, Integer.toString(getAudioAttributes().getFlags())); |
| } |
| record.put(ATT_LIGHTS, Boolean.toString(shouldShowLights())); |
| record.put(ATT_LIGHT_COLOR, Integer.toString(getLightColor())); |
| record.put(ATT_VIBRATION_ENABLED, Boolean.toString(shouldVibrate())); |
| record.put(ATT_USER_LOCKED, Integer.toString(getUserLockedFields())); |
| record.put(ATT_FG_SERVICE_SHOWN, Boolean.toString(isUserVisibleTaskShown())); |
| record.put(ATT_VIBRATION, longArrayToString(getVibrationPattern())); |
| if (getVibrationEffect() != null) { |
| record.put(ATT_VIBRATION_EFFECT, vibrationToString(getVibrationEffect())); |
| } |
| record.put(ATT_SHOW_BADGE, Boolean.toString(canShowBadge())); |
| record.put(ATT_DELETED, Boolean.toString(isDeleted())); |
| record.put(ATT_DELETED_TIME_MS, Long.toString(getDeletedTimeMs())); |
| record.put(ATT_GROUP, getGroup()); |
| record.put(ATT_BLOCKABLE_SYSTEM, isBlockable()); |
| record.put(ATT_ALLOW_BUBBLE, getAllowBubbles()); |
| // TODO: original importance |
| return record; |
| } |
| |
| private static AudioAttributes safeAudioAttributes(TypedXmlPullParser parser) { |
| int usage = safeInt(parser, ATT_USAGE, AudioAttributes.USAGE_NOTIFICATION); |
| int contentType = safeInt(parser, ATT_CONTENT_TYPE, |
| AudioAttributes.CONTENT_TYPE_SONIFICATION); |
| int flags = safeInt(parser, ATT_FLAGS, 0); |
| return new AudioAttributes.Builder() |
| .setUsage(usage) |
| .setContentType(contentType) |
| .setFlags(flags) |
| .build(); |
| } |
| |
| private static Uri safeUri(TypedXmlPullParser parser, String att) { |
| final String val = parser.getAttributeValue(null, att); |
| return val == null ? null : Uri.parse(val); |
| } |
| |
| private static String vibrationToString(VibrationEffect effect) { |
| StringWriter writer = new StringWriter(); |
| try { |
| VibrationXmlSerializer.serialize( |
| effect, writer, VibrationXmlSerializer.FLAG_ALLOW_HIDDEN_APIS); |
| } catch (IOException e) { |
| Log.e(TAG, "Unable to serialize vibration: " + effect, e); |
| } |
| return writer.toString(); |
| } |
| |
| private static VibrationEffect safeVibrationEffect(TypedXmlPullParser parser, String att) { |
| final String val = parser.getAttributeValue(null, att); |
| if (val != null) { |
| try { |
| return VibrationXmlParser.parseVibrationEffect( |
| new StringReader(val), VibrationXmlParser.FLAG_ALLOW_HIDDEN_APIS); |
| } catch (IOException e) { |
| Log.e(TAG, "Unable to read serialized vibration effect", e); |
| } |
| } |
| return null; |
| } |
| |
| private static int safeInt(TypedXmlPullParser parser, String att, int defValue) { |
| return parser.getAttributeInt(null, att, defValue); |
| } |
| |
| private static boolean safeBool(TypedXmlPullParser parser, String att, boolean defValue) { |
| return parser.getAttributeBoolean(null, att, defValue); |
| } |
| |
| private static long[] safeLongArray(TypedXmlPullParser parser, String att, long[] defValue) { |
| final String attributeValue = parser.getAttributeValue(null, att); |
| if (TextUtils.isEmpty(attributeValue)) return defValue; |
| String[] values = attributeValue.split(DELIMITER); |
| long[] longValues = new long[values.length]; |
| for (int i = 0; i < values.length; i++) { |
| try { |
| longValues[i] = Long.parseLong(values[i]); |
| } catch (NumberFormatException e) { |
| longValues[i] = 0; |
| } |
| } |
| return longValues; |
| } |
| |
| private static String longArrayToString(long[] values) { |
| StringBuilder sb = new StringBuilder(); |
| if (values != null && values.length > 0) { |
| for (int i = 0; i < values.length - 1; i++) { |
| sb.append(values[i]).append(DELIMITER); |
| } |
| sb.append(values[values.length - 1]); |
| } |
| return sb.toString(); |
| } |
| |
| public static final @android.annotation.NonNull Creator<NotificationChannel> CREATOR = |
| new Creator<NotificationChannel>() { |
| @Override |
| public NotificationChannel createFromParcel(Parcel in) { |
| return new NotificationChannel(in); |
| } |
| |
| @Override |
| public NotificationChannel[] newArray(int size) { |
| return new NotificationChannel[size]; |
| } |
| }; |
| |
| @Override |
| public int describeContents() { |
| return 0; |
| } |
| |
| @Override |
| public boolean equals(@Nullable Object o) { |
| if (this == o) return true; |
| if (o == null || getClass() != o.getClass()) return false; |
| NotificationChannel that = (NotificationChannel) o; |
| return getImportance() == that.getImportance() |
| && mBypassDnd == that.mBypassDnd |
| && getLockscreenVisibility() == that.getLockscreenVisibility() |
| && mLights == that.mLights |
| && getLightColor() == that.getLightColor() |
| && getUserLockedFields() == that.getUserLockedFields() |
| && isUserVisibleTaskShown() == that.isUserVisibleTaskShown() |
| && mVibrationEnabled == that.mVibrationEnabled |
| && mShowBadge == that.mShowBadge |
| && isDeleted() == that.isDeleted() |
| && getDeletedTimeMs() == that.getDeletedTimeMs() |
| && isBlockable() == that.isBlockable() |
| && mAllowBubbles == that.mAllowBubbles |
| && Objects.equals(getId(), that.getId()) |
| && Objects.equals(getName(), that.getName()) |
| && Objects.equals(mDesc, that.mDesc) |
| && Objects.equals(getSound(), that.getSound()) |
| && Arrays.equals(mVibrationPattern, that.mVibrationPattern) |
| && Objects.equals(getVibrationEffect(), that.getVibrationEffect()) |
| && Objects.equals(getGroup(), that.getGroup()) |
| && Objects.equals(getAudioAttributes(), that.getAudioAttributes()) |
| && mImportanceLockedDefaultApp == that.mImportanceLockedDefaultApp |
| && mOriginalImportance == that.mOriginalImportance |
| && Objects.equals(getParentChannelId(), that.getParentChannelId()) |
| && Objects.equals(getConversationId(), that.getConversationId()) |
| && isDemoted() == that.isDemoted() |
| && isImportantConversation() == that.isImportantConversation(); |
| } |
| |
| @Override |
| public int hashCode() { |
| int result = Objects.hash(getId(), getName(), mDesc, getImportance(), mBypassDnd, |
| getLockscreenVisibility(), getSound(), mLights, getLightColor(), |
| getUserLockedFields(), isUserVisibleTaskShown(), |
| mVibrationEnabled, mShowBadge, isDeleted(), getDeletedTimeMs(), |
| getGroup(), getAudioAttributes(), isBlockable(), mAllowBubbles, |
| mImportanceLockedDefaultApp, mOriginalImportance, getVibrationEffect(), |
| mParentId, mConversationId, mDemoted, mImportantConvo); |
| result = 31 * result + Arrays.hashCode(mVibrationPattern); |
| return result; |
| } |
| |
| /** @hide */ |
| public void dump(PrintWriter pw, String prefix, boolean redacted) { |
| String redactedName = redacted ? TextUtils.trimToLengthWithEllipsis(mName, 3) : mName; |
| String output = "NotificationChannel{" |
| + "mId='" + mId + '\'' |
| + ", mName=" + redactedName |
| + getFieldsString() |
| + '}'; |
| pw.println(prefix + output); |
| } |
| |
| @Override |
| public String toString() { |
| return "NotificationChannel{" |
| + "mId='" + mId + '\'' |
| + ", mName=" + mName |
| + getFieldsString() |
| + '}'; |
| } |
| |
| private String getFieldsString() { |
| return ", mDescription=" + (!TextUtils.isEmpty(mDesc) ? "hasDescription " : "") |
| + ", mImportance=" + mImportance |
| + ", mBypassDnd=" + mBypassDnd |
| + ", mLockscreenVisibility=" + mLockscreenVisibility |
| + ", mSound=" + mSound |
| + ", mLights=" + mLights |
| + ", mLightColor=" + mLightColor |
| + ", mVibrationPattern=" + Arrays.toString(mVibrationPattern) |
| + ", mVibrationEffect=" |
| + (mVibrationEffect == null ? "null" : mVibrationEffect.toString()) |
| + ", mUserLockedFields=" + Integer.toHexString(mUserLockedFields) |
| + ", mUserVisibleTaskShown=" + mUserVisibleTaskShown |
| + ", mVibrationEnabled=" + mVibrationEnabled |
| + ", mShowBadge=" + mShowBadge |
| + ", mDeleted=" + mDeleted |
| + ", mDeletedTimeMs=" + mDeletedTime |
| + ", mGroup='" + mGroup + '\'' |
| + ", mAudioAttributes=" + mAudioAttributes |
| + ", mBlockableSystem=" + mBlockableSystem |
| + ", mAllowBubbles=" + mAllowBubbles |
| + ", mImportanceLockedDefaultApp=" + mImportanceLockedDefaultApp |
| + ", mOriginalImp=" + mOriginalImportance |
| + ", mParent=" + mParentId |
| + ", mConversationId=" + mConversationId |
| + ", mDemoted=" + mDemoted |
| + ", mImportantConvo=" + mImportantConvo |
| + ", mLastNotificationUpdateTimeMs=" + mLastNotificationUpdateTimeMs; |
| } |
| |
| /** @hide */ |
| public void dumpDebug(ProtoOutputStream proto, long fieldId) { |
| final long token = proto.start(fieldId); |
| |
| proto.write(NotificationChannelProto.ID, mId); |
| proto.write(NotificationChannelProto.NAME, mName); |
| proto.write(NotificationChannelProto.DESCRIPTION, mDesc); |
| proto.write(NotificationChannelProto.IMPORTANCE, mImportance); |
| proto.write(NotificationChannelProto.CAN_BYPASS_DND, mBypassDnd); |
| proto.write(NotificationChannelProto.LOCKSCREEN_VISIBILITY, mLockscreenVisibility); |
| if (mSound != null) { |
| proto.write(NotificationChannelProto.SOUND, mSound.toString()); |
| } |
| proto.write(NotificationChannelProto.USE_LIGHTS, mLights); |
| proto.write(NotificationChannelProto.LIGHT_COLOR, mLightColor); |
| if (mVibrationPattern != null) { |
| for (long v : mVibrationPattern) { |
| proto.write(NotificationChannelProto.VIBRATION, v); |
| } |
| } |
| proto.write(NotificationChannelProto.USER_LOCKED_FIELDS, mUserLockedFields); |
| proto.write(NotificationChannelProto.USER_VISIBLE_TASK_SHOWN, mUserVisibleTaskShown); |
| proto.write(NotificationChannelProto.IS_VIBRATION_ENABLED, mVibrationEnabled); |
| proto.write(NotificationChannelProto.SHOW_BADGE, mShowBadge); |
| proto.write(NotificationChannelProto.IS_DELETED, mDeleted); |
| proto.write(NotificationChannelProto.GROUP, mGroup); |
| if (mAudioAttributes != null) { |
| mAudioAttributes.dumpDebug(proto, NotificationChannelProto.AUDIO_ATTRIBUTES); |
| } |
| proto.write(NotificationChannelProto.IS_BLOCKABLE_SYSTEM, mBlockableSystem); |
| proto.write(NotificationChannelProto.ALLOW_APP_OVERLAY, mAllowBubbles); |
| |
| proto.end(token); |
| } |
| } |
