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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/*
* 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 android.service.attention;
import android.annotation.IntDef;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.SystemApi;
import android.app.Service;
import android.content.Intent;
import android.os.IBinder;
import android.os.RemoteException;
import com.android.internal.util.Preconditions;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* Abstract base class for Attention service.
*
* <p> An attention service provides attention estimation related features to the system.
* The system's default AttentionService implementation is configured in
* {@code config_AttentionComponent}. If this config has no value, a stub is returned.
*
* See: {@link com.android.server.attention.AttentionManagerService}.
*
* <pre>
* {@literal
* <service android:name=".YourAttentionService"
* android:permission="android.permission.BIND_ATTENTION_SERVICE">
* </service>}
* </pre>
*
* @hide
*/
@SystemApi
public abstract class AttentionService extends Service {
/**
* The {@link Intent} that must be declared as handled by the service. To be supported, the
* service must also require the {@link android.Manifest.permission#BIND_ATTENTION_SERVICE}
* permission so that other applications can not abuse it.
*/
public static final String SERVICE_INTERFACE =
"android.service.attention.AttentionService";
/** Attention is absent. */
public static final int ATTENTION_SUCCESS_ABSENT = 0;
/** Attention is present. */
public static final int ATTENTION_SUCCESS_PRESENT = 1;
/** Unknown reasons for failing to determine the attention. */
public static final int ATTENTION_FAILURE_UNKNOWN = 2;
/** Request has been cancelled. */
public static final int ATTENTION_FAILURE_CANCELLED = 3;
/** Preempted by other client. */
public static final int ATTENTION_FAILURE_PREEMPTED = 4;
/** Request timed out. */
public static final int ATTENTION_FAILURE_TIMED_OUT = 5;
/** Camera permission is not granted. */
public static final int ATTENTION_FAILURE_CAMERA_PERMISSION_ABSENT = 6;
/**
* Result codes for when attention check was successful.
*
* @hide
*/
@IntDef(prefix = {"ATTENTION_SUCCESS_"}, value = {ATTENTION_SUCCESS_ABSENT,
ATTENTION_SUCCESS_PRESENT})
@Retention(RetentionPolicy.SOURCE)
public @interface AttentionSuccessCodes {
}
/**
* Result codes explaining why attention check was not successful.
*
* @hide
*/
@IntDef(prefix = {"ATTENTION_FAILURE_"}, value = {ATTENTION_FAILURE_UNKNOWN,
ATTENTION_FAILURE_CANCELLED, ATTENTION_FAILURE_PREEMPTED, ATTENTION_FAILURE_TIMED_OUT,
ATTENTION_FAILURE_CAMERA_PERMISSION_ABSENT})
@Retention(RetentionPolicy.SOURCE)
public @interface AttentionFailureCodes {
}
private final IAttentionService.Stub mBinder = new IAttentionService.Stub() {
/** {@inheritDoc} */
@Override
public void checkAttention(IAttentionCallback callback) {
Preconditions.checkNotNull(callback);
AttentionService.this.onCheckAttention(new AttentionCallback(callback));
}
/** {@inheritDoc} */
@Override
public void cancelAttentionCheck(IAttentionCallback callback) {
Preconditions.checkNotNull(callback);
AttentionService.this.onCancelAttentionCheck(new AttentionCallback(callback));
}
};
@Nullable
@Override
public final IBinder onBind(@NonNull Intent intent) {
if (SERVICE_INTERFACE.equals(intent.getAction())) {
return mBinder;
}
return null;
}
/**
* Checks the user attention and calls into the provided callback.
*
* @param callback the callback to return the result to
*/
public abstract void onCheckAttention(@NonNull AttentionCallback callback);
/**
* Cancels pending work for a given callback.
*
* Implementation must call back with a failure code of {@link #ATTENTION_FAILURE_CANCELLED}.
*/
public abstract void onCancelAttentionCheck(@NonNull AttentionCallback callback);
/** Callbacks for AttentionService results. */
public static final class AttentionCallback {
@NonNull private final IAttentionCallback mCallback;
private AttentionCallback(@NonNull IAttentionCallback callback) {
mCallback = callback;
}
/**
* Signals a success and provides the result code.
*
* @param timestamp of when the attention signal was computed; system throttles the requests
* so this is useful to know how fresh the result is.
*/
public void onSuccess(@AttentionSuccessCodes int result, long timestamp) {
try {
mCallback.onSuccess(result, timestamp);
} catch (RemoteException e) {
e.rethrowFromSystemServer();
}
}
/** Signals a failure and provides the error code. */
public void onFailure(@AttentionFailureCodes int error) {
try {
mCallback.onFailure(error);
} catch (RemoteException e) {
e.rethrowFromSystemServer();
}
}
}
}
|
