src.android.service.notification.Adjustment Maven / Gradle / Ivy
/*
* 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.service.notification;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.StringDef;
import android.annotation.SystemApi;
import android.app.Notification;
import android.os.Bundle;
import android.os.Parcel;
import android.os.Parcelable;
import android.os.UserHandle;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* Ranking updates from the Assistant.
*
* The updates are provides as a {@link Bundle} of signals, using the keys provided in this
* class.
* Each {@code KEY} specifies what type of data it supports and what kind of Adjustment it
* realizes on the notification rankings.
*
* Notifications affected by the Adjustment will be re-ranked if necessary.
*
* @hide
*/
@SystemApi
public final class Adjustment implements Parcelable {
private final String mPackage;
private final String mKey;
private final CharSequence mExplanation;
private final Bundle mSignals;
private final int mUser;
@Nullable private String mIssuer;
/** @hide */
@StringDef (prefix = { "KEY_" }, value = {
KEY_CONTEXTUAL_ACTIONS, KEY_GROUP_KEY, KEY_IMPORTANCE, KEY_PEOPLE, KEY_SNOOZE_CRITERIA,
KEY_TEXT_REPLIES, KEY_USER_SENTIMENT
})
@Retention(RetentionPolicy.SOURCE)
public @interface Keys {}
/**
* Data type: ArrayList of {@code String}, where each is a representation of a
* {@link android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI}.
* See {@link android.app.Notification.Builder#addPerson(String)}.
* @hide
*/
@SystemApi
public static final String KEY_PEOPLE = "key_people";
/**
* Parcelable {@code ArrayList} of {@link SnoozeCriterion}. These criteria may be visible to
* users. If a user chooses to snooze a notification until one of these criterion, the
* assistant will be notified via
* {@link NotificationAssistantService#onNotificationSnoozedUntilContext}.
*/
public static final String KEY_SNOOZE_CRITERIA = "key_snooze_criteria";
/**
* Data type: String. Used to change what {@link Notification#getGroup() group} a notification
* belongs to.
* @hide
*/
public static final String KEY_GROUP_KEY = "key_group_key";
/**
* Data type: int, one of {@link NotificationListenerService.Ranking#USER_SENTIMENT_POSITIVE},
* {@link NotificationListenerService.Ranking#USER_SENTIMENT_NEUTRAL},
* {@link NotificationListenerService.Ranking#USER_SENTIMENT_NEGATIVE}. Used to express how
* a user feels about notifications in the same {@link android.app.NotificationChannel} as
* the notification represented by {@link #getKey()}.
*/
public static final String KEY_USER_SENTIMENT = "key_user_sentiment";
/**
* Data type: ArrayList of {@link android.app.Notification.Action}.
* Used to suggest contextual actions for a notification.
*
* @see Notification.Action.Builder#setContextual(boolean)
*/
public static final String KEY_CONTEXTUAL_ACTIONS = "key_contextual_actions";
/**
* Data type: ArrayList of {@link CharSequence}.
* Used to suggest smart replies for a notification.
*/
public static final String KEY_TEXT_REPLIES = "key_text_replies";
/**
* Data type: int, one of importance values e.g.
* {@link android.app.NotificationManager#IMPORTANCE_MIN}.
*
* If used from
* {@link NotificationAssistantService#onNotificationEnqueued(StatusBarNotification)}, and
* received before the notification is posted, it can block a notification from appearing or
* silence it. Importance adjustments received too late from
* {@link NotificationAssistantService#onNotificationEnqueued(StatusBarNotification)} will be
* ignored.
*
* If used from
* {@link NotificationAssistantService#adjustNotification(Adjustment)}, it can
* visually demote or cancel a notification, but use this with care if they notification was
* recently posted because the notification may already have made noise.
*
*/
public static final String KEY_IMPORTANCE = "key_importance";
/**
* Data type: float, a ranking score from 0 (lowest) to 1 (highest).
* Used to rank notifications inside that fall under the same classification (i.e. alerting,
* silenced).
*/
public static final String KEY_RANKING_SCORE = "key_ranking_score";
/**
* Data type: boolean, when true it suggests this is NOT a conversation notification.
* @hide
*/
@SystemApi
public static final String KEY_NOT_CONVERSATION = "key_not_conversation";
/**
* Create a notification adjustment.
*
* @param pkg The package of the notification.
* @param key The notification key.
* @param signals A bundle of signals that should inform notification display, ordering, and
* interruptiveness.
* @param explanation A human-readable justification for the adjustment.
* @hide
*/
@SystemApi
public Adjustment(String pkg, String key, Bundle signals, CharSequence explanation, int user) {
mPackage = pkg;
mKey = key;
mSignals = signals;
mExplanation = explanation;
mUser = user;
}
/**
* Create a notification adjustment.
*
* @param pkg The package of the notification.
* @param key The notification key.
* @param signals A bundle of signals that should inform notification display, ordering, and
* interruptiveness.
* @param explanation A human-readable justification for the adjustment.
* @param userHandle User handle for for whose the adjustments will be applied.
*/
public Adjustment(@NonNull String pkg, @NonNull String key, @NonNull Bundle signals,
@NonNull CharSequence explanation,
@NonNull UserHandle userHandle) {
mPackage = pkg;
mKey = key;
mSignals = signals;
mExplanation = explanation;
mUser = userHandle.getIdentifier();
}
/**
* @hide
*/
@SystemApi
protected Adjustment(Parcel in) {
if (in.readInt() == 1) {
mPackage = in.readString();
} else {
mPackage = null;
}
if (in.readInt() == 1) {
mKey = in.readString();
} else {
mKey = null;
}
if (in.readInt() == 1) {
mExplanation = in.readCharSequence();
} else {
mExplanation = null;
}
mSignals = in.readBundle();
mUser = in.readInt();
mIssuer = in.readString();
}
public static final @android.annotation.NonNull Creator CREATOR = new Creator() {
@Override
public Adjustment createFromParcel(Parcel in) {
return new Adjustment(in);
}
@Override
public Adjustment[] newArray(int size) {
return new Adjustment[size];
}
};
public @NonNull String getPackage() {
return mPackage;
}
public @NonNull String getKey() {
return mKey;
}
public @NonNull CharSequence getExplanation() {
return mExplanation;
}
public @NonNull Bundle getSignals() {
return mSignals;
}
/** @hide */
@SystemApi
public int getUser() {
return mUser;
}
public @NonNull UserHandle getUserHandle() {
return UserHandle.of(mUser);
}
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(Parcel dest, int flags) {
if (mPackage != null) {
dest.writeInt(1);
dest.writeString(mPackage);
} else {
dest.writeInt(0);
}
if (mKey != null) {
dest.writeInt(1);
dest.writeString(mKey);
} else {
dest.writeInt(0);
}
if (mExplanation != null) {
dest.writeInt(1);
dest.writeCharSequence(mExplanation);
} else {
dest.writeInt(0);
}
dest.writeBundle(mSignals);
dest.writeInt(mUser);
dest.writeString(mIssuer);
}
@NonNull
@Override
public String toString() {
return "Adjustment{"
+ "mSignals=" + mSignals
+ '}';
}
/** @hide */
public void setIssuer(@Nullable String issuer) {
mIssuer = issuer;
}
/** @hide */
public @Nullable String getIssuer() {
return mIssuer;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy