summaryrefslogtreecommitdiff
path: root/src/com/android/launcher3/shortcuts/ShortcutRequest.java
blob: 21efceb0fdeb2fe96fa66e64e9bb61a6098320f9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/*
 * Copyright (C) 2020 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.launcher3.shortcuts;

import static com.android.launcher3.model.WidgetsModel.GO_DISABLE_WIDGETS;

import android.content.ComponentName;
import android.content.Context;
import android.content.pm.LauncherApps;
import android.content.pm.LauncherApps.ShortcutQuery;
import android.content.pm.ShortcutInfo;
import android.os.UserHandle;

import androidx.annotation.Nullable;

import com.android.launcher3.logging.FileLog;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

/**
 * Utility class to streamline Shortcut query
 */
public class ShortcutRequest {

    private static final String TAG = "ShortcutRequest";

    public static final int ALL = ShortcutQuery.FLAG_MATCH_DYNAMIC
            | ShortcutQuery.FLAG_MATCH_MANIFEST | ShortcutQuery.FLAG_MATCH_PINNED;
    public static final int PUBLISHED = ShortcutQuery.FLAG_MATCH_DYNAMIC
            | ShortcutQuery.FLAG_MATCH_MANIFEST;
    public static final int PINNED = ShortcutQuery.FLAG_MATCH_PINNED;

    private final ShortcutQuery mQuery = GO_DISABLE_WIDGETS ? null : new ShortcutQuery();

    private final Context mContext;
    private final UserHandle mUserHandle;

    boolean mFailed = false;

    public ShortcutRequest(Context context, UserHandle userHandle) {
        mContext = context;
        mUserHandle = userHandle;
    }

    /** @see #forPackage(String, List) */
    public ShortcutRequest forPackage(String packageName) {
        return forPackage(packageName, (List<String>) null);
    }

    /** @see #forPackage(String, List) */
    public ShortcutRequest forPackage(String packageName, String... shortcutIds) {
        return forPackage(packageName, Arrays.asList(shortcutIds));
    }

    /**
     * @param shortcutIds If null, match all shortcuts, otherwise only match the given id's.
     * @return A list of ShortcutInfo's associated with the given package.
     */
    public ShortcutRequest forPackage(String packageName, @Nullable List<String> shortcutIds) {
        if (!GO_DISABLE_WIDGETS && packageName != null) {
            mQuery.setPackage(packageName);
            mQuery.setShortcutIds(shortcutIds);
        }
        return this;
    }

    public ShortcutRequest withContainer(@Nullable ComponentName activity) {
        if (!GO_DISABLE_WIDGETS) {
            if (activity == null) {
                mFailed = true;
            } else {
                mQuery.setActivity(activity);
            }
        }
        return this;
    }

    public QueryResult query(int flags) {
        if (GO_DISABLE_WIDGETS || mFailed) {
            return QueryResult.DEFAULT;
        }
        mQuery.setQueryFlags(flags);

        try {
            return new QueryResult(mContext.getSystemService(LauncherApps.class)
                    .getShortcuts(mQuery, mUserHandle));
        } catch (SecurityException | IllegalStateException e) {
            FileLog.e(TAG, "Failed to query for shortcuts", e);
            return QueryResult.DEFAULT;
        }
    }

    public static class QueryResult extends ArrayList<ShortcutInfo> {

        static final QueryResult DEFAULT = new QueryResult(GO_DISABLE_WIDGETS);

        private final boolean mWasSuccess;

        QueryResult(List<ShortcutInfo> result) {
            super(result == null ? Collections.emptyList() : result);
            mWasSuccess = true;
        }

        QueryResult(boolean wasSuccess) {
            mWasSuccess = wasSuccess;
        }


        public boolean wasSuccess() {
            return mWasSuccess;
        }
    }
}