1 /*
2  * Copyright (C) 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package android.appwidget;
18 
19 import android.annotation.Nullable;
20 import android.util.ArraySet;
21 
22 import java.util.Set;
23 
24 /**
25  * App widget manager local system service interface.
26  *
27  * @hide Only for use within the system server.
28  */
29 public abstract class AppWidgetManagerInternal {
30 
31     /**
32      * Gets the packages from which the uid hosts widgets.
33      *
34      * @param uid The potential host UID.
35      * @return Whether the UID hosts widgets from the package.
36      */
getHostedWidgetPackages(int uid)37     public abstract @Nullable ArraySet<String> getHostedWidgetPackages(int uid);
38 
39     /**
40      * Execute the widget-related work of unlocking a user.  This is intentionally
41      * invoked just <em>before</em> the boot-completed broadcast is issued, after
42      * the data-related work of unlock has completed.
43      *
44      * @param userId The user that is being unlocked.
45      */
unlockUser(int userId)46     public abstract void unlockUser(int userId);
47 
48     /**
49      * Updates all widgets, applying changes to Runtime Resource Overlay affecting the specified
50      * target packages.
51      *
52      * @param packageNames The names of all target packages for which an overlay was modified
53      * @param userId The user for which overlay modifications occurred.
54      * @param updateFrameworkRes Whether or not an overlay affected the values of framework
55      *                           resources.
56      */
applyResourceOverlaysToWidgets(Set<String> packageNames, int userId, boolean updateFrameworkRes)57     public abstract void applyResourceOverlaysToWidgets(Set<String> packageNames, int userId,
58             boolean updateFrameworkRes);
59 }
60