TileService.java revision a3453b8bd9af44566c6a31fd0156cc76e6028f6d
1/* 2 * Copyright (C) 2015 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 */ 16package android.service.quicksettings; 17 18import android.Manifest; 19import android.annotation.SdkConstant; 20import android.annotation.SdkConstant.SdkConstantType; 21import android.annotation.SystemApi; 22import android.app.Dialog; 23import android.app.Service; 24import android.content.ComponentName; 25import android.content.Context; 26import android.content.Intent; 27import android.graphics.drawable.Icon; 28import android.os.Handler; 29import android.os.IBinder; 30import android.os.Looper; 31import android.os.Message; 32import android.os.RemoteException; 33import android.view.View; 34import android.view.View.OnAttachStateChangeListener; 35import android.view.WindowManager; 36 37/** 38 * A TileService provides the user a tile that can be added to Quick Settings. 39 * Quick Settings is a space provided that allows the user to change settings and 40 * take quick actions without leaving the context of their current app. 41 * 42 * <p>The lifecycle of a TileService is different from some other services in 43 * that it may be unbound during parts of its lifecycle. Any of the following 44 * lifecycle events can happen indepently in a separate binding/creation of the 45 * service.</p> 46 * 47 * <ul> 48 * <li>When a tile is added by the user its TileService will be bound to and 49 * {@link #onTileAdded()} will be called.</li> 50 * 51 * <li>When a tile should be up to date and listing will be indicated by 52 * {@link #onStartListening()} and {@link #onStopListening()}.</li> 53 * 54 * <li>When the user removes a tile from Quick Settings {@link #onTileRemoved()} 55 * will be called.</li> 56 * </ul> 57 * <p>TileService will be detected by tiles that match the {@value #ACTION_QS_TILE} 58 * and require the permission "android.permission.BIND_QUICK_SETTINGS_TILE". 59 * The label and icon for the service will be used as the default label and 60 * icon for the tile. Here is an example TileService declaration.</p> 61 * <pre class="prettyprint"> 62 * {@literal 63 * <service 64 * android:name=".MyQSTileService" 65 * android:label="@string/my_default_tile_label" 66 * android:icon="@drawable/my_default_icon_label" 67 * android:permission="android.permission.BIND_QUICK_SETTINGS_TILE"> 68 * <intent-filter> 69 * <action android:name="android.service.quicksettings.action.QS_TILE" /> 70 * </intent-filter> 71 * </service>} 72 * </pre> 73 * 74 * @see Tile Tile for details about the UI of a Quick Settings Tile. 75 */ 76public class TileService extends Service { 77 78 /** 79 * An activity that provides a user interface for adjusting TileService preferences. 80 * Optional but recommended for apps that implement a TileService. 81 */ 82 @SdkConstant(SdkConstantType.INTENT_CATEGORY) 83 public static final String ACTION_QS_TILE_PREFERENCES 84 = "android.service.quicksettings.action.QS_TILE_PREFERENCES"; 85 86 /** 87 * Action that identifies a Service as being a TileService. 88 */ 89 public static final String ACTION_QS_TILE = "android.service.quicksettings.action.QS_TILE"; 90 91 /** 92 * Meta-data for tile definition to set a tile into active mode. 93 * <p> 94 * Active mode is for tiles which already listen and keep track of their state in their 95 * own process. These tiles may request to send an update to the System while their process 96 * is alive using {@link #requestListeningState}. The System will only bind these tiles 97 * on its own when a click needs to occur. 98 * 99 * To make a TileService an active tile, set this meta-data to true on the TileService's 100 * manifest declaration. 101 * <pre class="prettyprint"> 102 * {@literal 103 * <meta-data android:name="android.service.quicksettings.ACTIVE_TILE" 104 * android:value="true" /> 105 * } 106 * </pre> 107 */ 108 public static final String META_DATA_ACTIVE_TILE 109 = "android.service.quicksettings.ACTIVE_TILE"; 110 111 /** 112 * Used to notify SysUI that Listening has be requested. 113 * @hide 114 */ 115 public static final String ACTION_REQUEST_LISTENING 116 = "android.service.quicksettings.action.REQUEST_LISTENING"; 117 118 /** 119 * @hide 120 */ 121 public static final String EXTRA_SERVICE = "service"; 122 123 /** 124 * @hide 125 */ 126 public static final String EXTRA_TILE = "tile"; 127 128 /** 129 * @hide 130 */ 131 public static final String EXTRA_COMPONENT = "android.service.quicksettings.extra.COMPONENT"; 132 133 private final H mHandler = new H(Looper.getMainLooper()); 134 135 private boolean mListening = false; 136 private Tile mTile; 137 private IBinder mToken; 138 private IQSService mService; 139 private Runnable mUnlockRunnable; 140 141 @Override 142 public void onDestroy() { 143 if (mListening) { 144 onStopListening(); 145 mListening = false; 146 } 147 super.onDestroy(); 148 } 149 150 /** 151 * Called when the user adds this tile to Quick Settings. 152 * <p/> 153 * Note that this is not guaranteed to be called between {@link #onCreate()} 154 * and {@link #onStartListening()}, it will only be called when the tile is added 155 * and not on subsequent binds. 156 */ 157 public void onTileAdded() { 158 } 159 160 /** 161 * Called when the user removes this tile from Quick Settings. 162 */ 163 public void onTileRemoved() { 164 } 165 166 /** 167 * Called when this tile moves into a listening state. 168 * <p/> 169 * When this tile is in a listening state it is expected to keep the 170 * UI up to date. Any listeners or callbacks needed to keep this tile 171 * up to date should be registered here and unregistered in {@link #onStopListening()}. 172 * 173 * @see #getQsTile() 174 * @see Tile#updateTile() 175 */ 176 public void onStartListening() { 177 } 178 179 /** 180 * Called when this tile moves out of the listening state. 181 */ 182 public void onStopListening() { 183 } 184 185 /** 186 * Called when the user clicks on this tile. 187 */ 188 public void onClick() { 189 } 190 191 /** 192 * Sets an icon to be shown in the status bar. 193 * <p> 194 * The icon will be displayed before all other icons. Can only be called between 195 * {@link #onStartListening} and {@link #onStopListening}. Can only be called by system apps. 196 * 197 * @param icon The icon to be displayed, null to hide 198 * @param contentDescription Content description of the icon to be displayed 199 * @hide 200 */ 201 @SystemApi 202 public final void setStatusIcon(Icon icon, String contentDescription) { 203 if (mService != null) { 204 try { 205 mService.updateStatusIcon(mTile, icon, contentDescription); 206 } catch (RemoteException e) { 207 } 208 } 209 } 210 211 /** 212 * Used to show a dialog. 213 * 214 * This will collapse the Quick Settings panel and show the dialog. 215 * 216 * @param dialog Dialog to show. 217 * 218 * @see #isLocked() 219 */ 220 public final void showDialog(Dialog dialog) { 221 dialog.getWindow().getAttributes().token = mToken; 222 dialog.getWindow().setType(WindowManager.LayoutParams.TYPE_QS_DIALOG); 223 dialog.getWindow().getDecorView().addOnAttachStateChangeListener( 224 new OnAttachStateChangeListener() { 225 @Override 226 public void onViewAttachedToWindow(View v) { 227 } 228 229 @Override 230 public void onViewDetachedFromWindow(View v) { 231 try { 232 mService.onDialogHidden(getQsTile()); 233 } catch (RemoteException e) { 234 } 235 } 236 }); 237 dialog.show(); 238 try { 239 mService.onShowDialog(mTile); 240 } catch (RemoteException e) { 241 } 242 } 243 244 /** 245 * Prompts the user to unlock the device before executing the Runnable. 246 * <p> 247 * The user will be prompted for their current security method if applicable 248 * and if successful, runnable will be executed. The Runnable will not be 249 * executed if the user fails to unlock the device or cancels the operation. 250 */ 251 public final void unlockAndRun(Runnable runnable) { 252 mUnlockRunnable = runnable; 253 try { 254 mService.startUnlockAndRun(mTile); 255 } catch (RemoteException e) { 256 } 257 } 258 259 /** 260 * Checks if the device is in a secure state. 261 * 262 * TileServices should detect when the device is secure and change their behavior 263 * accordingly. 264 * 265 * @return true if the device is secure. 266 */ 267 public final boolean isSecure() { 268 try { 269 return mService.isSecure(); 270 } catch (RemoteException e) { 271 return true; 272 } 273 } 274 275 /** 276 * Checks if the lock screen is showing. 277 * 278 * When a device is locked, then {@link #showDialog} will not present a dialog, as it will 279 * be under the lock screen. If the behavior of the Tile is safe to do while locked, 280 * then the user should use {@link #startActivity} to launch an activity on top of the lock 281 * screen, otherwise the tile should use {@link #unlockAndRun(Runnable)} to give the 282 * user their security challenge. 283 * 284 * @return true if the device is locked. 285 */ 286 public final boolean isLocked() { 287 try { 288 return mService.isLocked(); 289 } catch (RemoteException e) { 290 return true; 291 } 292 } 293 294 /** 295 * Start an activity while collapsing the panel. 296 */ 297 public final void startActivityAndCollapse(Intent intent) { 298 startActivity(intent); 299 try { 300 mService.onStartActivity(mTile); 301 } catch (RemoteException e) { 302 } 303 } 304 305 /** 306 * Gets the {@link Tile} for this service. 307 * <p/> 308 * This tile may be used to get or set the current state for this 309 * tile. This tile is only valid for updates between {@link #onStartListening()} 310 * and {@link #onStopListening()}. 311 */ 312 public final Tile getQsTile() { 313 return mTile; 314 } 315 316 @Override 317 public IBinder onBind(Intent intent) { 318 mTile = intent.getParcelableExtra(EXTRA_TILE); 319 mService = IQSService.Stub.asInterface(intent.getIBinderExtra(EXTRA_SERVICE)); 320 mTile.setService(mService); 321 return new IQSTileService.Stub() { 322 @Override 323 public void onTileRemoved() throws RemoteException { 324 mHandler.sendEmptyMessage(H.MSG_TILE_REMOVED); 325 } 326 327 @Override 328 public void onTileAdded() throws RemoteException { 329 mHandler.sendEmptyMessage(H.MSG_TILE_ADDED); 330 } 331 332 @Override 333 public void onStopListening() throws RemoteException { 334 mHandler.sendEmptyMessage(H.MSG_STOP_LISTENING); 335 } 336 337 @Override 338 public void onStartListening() throws RemoteException { 339 mHandler.sendEmptyMessage(H.MSG_START_LISTENING); 340 } 341 342 @Override 343 public void onClick(IBinder wtoken) throws RemoteException { 344 mHandler.obtainMessage(H.MSG_TILE_CLICKED, wtoken).sendToTarget(); 345 } 346 347 @Override 348 public void onUnlockComplete() throws RemoteException{ 349 mHandler.sendEmptyMessage(H.MSG_UNLOCK_COMPLETE); 350 } 351 }; 352 } 353 354 private class H extends Handler { 355 private static final int MSG_START_LISTENING = 1; 356 private static final int MSG_STOP_LISTENING = 2; 357 private static final int MSG_TILE_ADDED = 3; 358 private static final int MSG_TILE_REMOVED = 4; 359 private static final int MSG_TILE_CLICKED = 5; 360 private static final int MSG_UNLOCK_COMPLETE = 6; 361 362 public H(Looper looper) { 363 super(looper); 364 } 365 366 @Override 367 public void handleMessage(Message msg) { 368 switch (msg.what) { 369 case MSG_TILE_ADDED: 370 TileService.this.onTileAdded(); 371 break; 372 case MSG_TILE_REMOVED: 373 if (mListening) { 374 mListening = false; 375 TileService.this.onStopListening(); 376 } 377 TileService.this.onTileRemoved(); 378 break; 379 case MSG_STOP_LISTENING: 380 if (mListening) { 381 mListening = false; 382 TileService.this.onStopListening(); 383 } 384 break; 385 case MSG_START_LISTENING: 386 if (!mListening) { 387 mListening = true; 388 TileService.this.onStartListening(); 389 } 390 break; 391 case MSG_TILE_CLICKED: 392 mToken = (IBinder) msg.obj; 393 TileService.this.onClick(); 394 break; 395 case MSG_UNLOCK_COMPLETE: 396 if (mUnlockRunnable != null) { 397 mUnlockRunnable.run(); 398 } 399 break; 400 } 401 } 402 } 403 404 /** 405 * Requests that a tile be put in the listening state so it can send an update. 406 * 407 * This method is only applicable to tiles that have {@link #META_DATA_ACTIVE_TILE} defined 408 * as true on their TileService Manifest declaration, and will do nothing otherwise. 409 */ 410 public static final void requestListeningState(Context context, ComponentName component) { 411 Intent intent = new Intent(ACTION_REQUEST_LISTENING); 412 intent.putExtra(EXTRA_COMPONENT, component); 413 context.sendBroadcast(intent, Manifest.permission.BIND_QUICK_SETTINGS_TILE); 414 } 415} 416