| /* |
| * Copyright (C) 2019 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 com.android.systemui.plugins; |
| |
| import android.annotation.Nullable; |
| import android.app.PendingIntent; |
| import android.graphics.drawable.Drawable; |
| import android.service.notification.StatusBarNotification; |
| |
| import com.android.systemui.plugins.annotations.DependsOn; |
| import com.android.systemui.plugins.annotations.ProvidesInterface; |
| |
| /** Custom logic that can extract a PeopleHub "person" from a notification. */ |
| @ProvidesInterface( |
| action = NotificationPersonExtractorPlugin.ACTION, |
| version = NotificationPersonExtractorPlugin.VERSION) |
| @DependsOn(target = NotificationPersonExtractorPlugin.PersonData.class) |
| public interface NotificationPersonExtractorPlugin extends Plugin { |
| |
| String ACTION = "com.android.systemui.action.PEOPLE_HUB_PERSON_EXTRACTOR"; |
| int VERSION = 1; |
| |
| /** |
| * Attempts to extract a person from a notification. Returns {@code null} if one is not found. |
| */ |
| @Nullable |
| PersonData extractPerson(StatusBarNotification sbn); |
| |
| /** |
| * Attempts to extract a person id from a notification. Returns {@code null} if one is not |
| * found. |
| * |
| * This method can be overridden in order to provide a faster implementation. |
| */ |
| @Nullable |
| default String extractPersonKey(StatusBarNotification sbn) { |
| return extractPerson(sbn).key; |
| } |
| |
| /** |
| * Determines whether or not a notification should be treated as having a person. Used for |
| * appropriate positioning in the notification shade. |
| */ |
| default boolean isPersonNotification(StatusBarNotification sbn) { |
| return extractPersonKey(sbn) != null; |
| } |
| |
| /** A person to be surfaced in PeopleHub. */ |
| @ProvidesInterface(version = PersonData.VERSION) |
| final class PersonData { |
| |
| public static final int VERSION = 0; |
| |
| public final String key; |
| public final CharSequence name; |
| public final Drawable avatar; |
| public final PendingIntent clickIntent; |
| |
| public PersonData(String key, CharSequence name, Drawable avatar, |
| PendingIntent clickIntent) { |
| this.key = key; |
| this.name = name; |
| this.avatar = avatar; |
| this.clickIntent = clickIntent; |
| } |
| } |
| } |