/*
* Copyright (C) 2008 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.app.Notification;
import android.os.Parcel;
import android.os.Parcelable;
import android.os.UserHandle;
/**
* Class encapsulating a Notification. Sent by the NotificationManagerService to clients including
* the status bar and any {@link android.service.notification.NotificationListenerService}s.
*/
public class StatusBarNotification implements Parcelable {
private final String pkg;
private final int id;
private final String tag;
private final String key;
private final String groupKey;
private final int uid;
private final String opPkg;
private final int initialPid;
private final Notification notification;
private final UserHandle user;
private final long postTime;
private final int score;
/** @hide */
public StatusBarNotification(String pkg, String opPkg, int id, String tag, int uid,
int initialPid, int score, Notification notification, UserHandle user) {
this(pkg, opPkg, id, tag, uid, initialPid, score, notification, user,
System.currentTimeMillis());
}
public StatusBarNotification(String pkg, String opPkg, int id, String tag, int uid,
int initialPid, int score, Notification notification, UserHandle user,
long postTime) {
if (pkg == null) throw new NullPointerException();
if (notification == null) throw new NullPointerException();
this.pkg = pkg;
this.opPkg = opPkg;
this.id = id;
this.tag = tag;
this.uid = uid;
this.initialPid = initialPid;
this.score = score;
this.notification = notification;
this.user = user;
this.postTime = postTime;
this.key = key();
this.groupKey = groupKey();
}
public StatusBarNotification(Parcel in) {
this.pkg = in.readString();
this.opPkg = in.readString();
this.id = in.readInt();
if (in.readInt() != 0) {
this.tag = in.readString();
} else {
this.tag = null;
}
this.uid = in.readInt();
this.initialPid = in.readInt();
this.score = in.readInt();
this.notification = new Notification(in);
this.user = UserHandle.readFromParcel(in);
this.postTime = in.readLong();
this.key = key();
this.groupKey = groupKey();
}
private String key() {
return user.getIdentifier() + "|" + pkg + "|" + id + "|" + tag + "|" + uid;
}
private String groupKey() {
final String group = getNotification().getGroup();
final String sortKey = getNotification().getSortKey();
if (group == null && sortKey == null) {
// a group of one
return key;
}
return user.getIdentifier() + "|" + pkg + "|" +
(group == null
? "p:" + notification.priority
: "g:" + group);
}
public void writeToParcel(Parcel out, int flags) {
out.writeString(this.pkg);
out.writeString(this.opPkg);
out.writeInt(this.id);
if (this.tag != null) {
out.writeInt(1);
out.writeString(this.tag);
} else {
out.writeInt(0);
}
out.writeInt(this.uid);
out.writeInt(this.initialPid);
out.writeInt(this.score);
this.notification.writeToParcel(out, flags);
user.writeToParcel(out, flags);
out.writeLong(this.postTime);
}
public int describeContents() {
return 0;
}
public static final Parcelable.Creator<StatusBarNotification> CREATOR
= new Parcelable.Creator<StatusBarNotification>()
{
public StatusBarNotification createFromParcel(Parcel parcel)
{
return new StatusBarNotification(parcel);
}
public StatusBarNotification[] newArray(int size)
{
return new StatusBarNotification[size];
}
};
/**
* @hide
*/
public StatusBarNotification cloneLight() {
final Notification no = new Notification();
this.notification.cloneInto(no, false); // light copy
return new StatusBarNotification(this.pkg, this.opPkg,
this.id, this.tag, this.uid, this.initialPid,
this.score, no, this.user, this.postTime);
}
@Override
public StatusBarNotification clone() {
return new StatusBarNotification(this.pkg, this.opPkg,
this.id, this.tag, this.uid, this.initialPid,
this.score, this.notification.clone(), this.user, this.postTime);
}
@Override
public String toString() {
return String.format(
"StatusBarNotification(pkg=%s user=%s id=%d tag=%s score=%d key=%s: %s)",
this.pkg, this.user, this.id, this.tag,
this.score, this.key, this.notification);
}
/** Convenience method to check the notification's flags for
* {@link Notification#FLAG_ONGOING_EVENT}.
*/
public boolean isOngoing() {
return (notification.flags & Notification.FLAG_ONGOING_EVENT) != 0;
}
/** Convenience method to check the notification's flags for
* either {@link Notification#FLAG_ONGOING_EVENT} or
* {@link Notification#FLAG_NO_CLEAR}.
*/
public boolean isClearable() {
return ((notification.flags & Notification.FLAG_ONGOING_EVENT) == 0)
&& ((notification.flags & Notification.FLAG_NO_CLEAR) == 0);
}
/**
* Returns a userHandle for the instance of the app that posted this notification.
*
* @deprecated Use {@link #getUser()} instead.
*/
public int getUserId() {
return this.user.getIdentifier();
}
/** The package of the app that posted the notification. */
public String getPackageName() {
return pkg;
}
/** The id supplied to {@link android.app.NotificationManager#notify(int,Notification)}. */
public int getId() {
return id;
}
/** The tag supplied to {@link android.app.NotificationManager#notify(int,Notification)},
* or null if no tag was specified. */
public String getTag() {
return tag;
}
/** The notifying app's calling uid. @hide */
public int getUid() {
return uid;
}
/** The package used for AppOps tracking. @hide */
public String getOpPkg() {
return opPkg;
}
/** @hide */
public int getInitialPid() {
return initialPid;
}
/** The {@link android.app.Notification} supplied to
* {@link android.app.NotificationManager#notify(int,Notification)}. */
public Notification getNotification() {
return notification;
}
/**
* The {@link android.os.UserHandle} for whom this notification is intended.
*/
public UserHandle getUser() {
return user;
}
/** The time (in {@link System#currentTimeMillis} time) the notification was posted,
* which may be different than {@link android.app.Notification#when}.
*/
public long getPostTime() {
return postTime;
}
/** @hide */
public int getScore() {
return score;
}
/**
* A unique instance key for this notification record.
*/
public String getKey() {
return key;
}
/**
* A key that indicates the group with which this message ranks.
*/
public String getGroupKey() {
return groupKey;
}
}
|
