File: SmartspaceManager.java

package info (click to toggle)
android-platform-frameworks-base 1%3A14~beta1-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 326,092 kB
  • sloc: java: 2,032,373; xml: 343,016; cpp: 304,181; python: 3,683; ansic: 2,090; sh: 1,871; makefile: 117; sed: 19
file content (64 lines) | stat: -rw-r--r-- 2,300 bytes parent folder | download | duplicates (2)
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
/*
 * Copyright (C) 2021 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.app.smartspace;

import android.annotation.NonNull;
import android.annotation.SystemApi;
import android.content.Context;

import java.util.Objects;

/**
 * Smartspace is a container in Android which is used to show contextual content powered by the
 * intelligence service running on the device. A smartspace container can be on AoD, lockscreen or
 * on the homescreen and can show personalized cards which are either derived from on device or
 * online signals.
 *
 * {@link SmartspaceManager} is a system service that provides methods to create Smartspace session
 * clients. An instance of this class is returned when a client calls
 * <code> context.getSystemService("smartspace"); </code>.
 *
 * After receiving the service, a client must call
 * {@link SmartspaceManager#createSmartspaceSession(SmartspaceConfig)} with a corresponding
 * {@link SmartspaceConfig} to get an instance of {@link SmartspaceSession}.
 * This session is then a client's point of contact with the api. They can send events, request for
 * updates using the session. It is client's duty to call {@link SmartspaceSession#destroy()} to
 * destroy the session once they no longer need it.
 *
 * @hide
 */
@SystemApi
public final class SmartspaceManager {

    private final Context mContext;

    /**
     * @hide
     */
    public SmartspaceManager(Context context) {
        mContext = Objects.requireNonNull(context);
    }

    /**
     * Creates a new Smartspace session.
     */
    @NonNull
    public SmartspaceSession createSmartspaceSession(
            @NonNull SmartspaceConfig smartspaceConfig) {
        return new SmartspaceSession(mContext, smartspaceConfig);
    }
}