/

• English
• Deutsch
• Español – América Latina
• Français
• Indonesia
• Polski
• Português – Brasil
• Tiếng Việt
• 中文 – 简体
• 日本語
• 한국어

Android Studio Sign in

• API reference

Service

public abstract class Service
extends ContextWrapper implements ComponentCallbacks2

OffHostApduService is a convenience Service class that can be extended to describe one or more NFC applications that are residing off-host, for example on an embedded secure element or a UICC.  PccService Abstract base class for a PCC service that receives data from other components.  PrintService

This is the base class for implementing print services.  QuickAccessWalletService A QuickAccessWalletService provides a list of WalletCards shown in the Quick Access Wallet.  RecognitionService This class provides a base class for recognition service implementations.  RemoteViewsService The service to be connected to for a remote adapter to request RemoteViews.  SettingInjectorService Dynamically specifies the summary (subtitle) and enabled status of a preference injected into the list of app settings displayed by the system settings app

A Service is an application component representing either an application's desire to perform a longer-running operation while not interacting with the user or to supply functionality for other applications to use. Each service class must have a corresponding <service> declaration in its package's AndroidManifest.xml. Services can be started with Context.startService() and Context.bindService().

Note that services, like other application objects, run in the main thread of their hosting process. This means that, if your service is going to do any CPU intensive (such as MP3 playback) or blocking (such as networking) operations, it should spawn its own thread in which to do that work. More information on this can be found in Processes and Threads. The JobIntentService class is available as a standard implementation of Service that has its own thread where it schedules its work to be done.

Topics covered here:

1. What is a Service?
2. Service Lifecycle
3. Permissions
4. Process Lifecycle
5. Local Service Sample
6. Remote Messenger Service Sample

What is a Service?

Most confusion about the Service class actually revolves around what it is not:

• A Service is not a separate process. The Service object itself does not imply it is running in its own process; unless otherwise specified, it runs in the same process as the application it is part of.
• A Service is not a thread. It is not a means itself to do work off of the main thread (to avoid Application Not Responding errors).

Thus a Service itself is actually very simple, providing two main features:

• A facility for the application to tell the system about something it wants to be doing in the background (even when the user is not directly interacting with the application). This corresponds to calls to Context.startService(), which ask the system to schedule work for the service, to be run until the service or someone else explicitly stop it.
• A facility for an application to expose some of its functionality to other applications. This corresponds to calls to Context.bindService(), which allows a long-standing connection to be made to the service in order to interact with it.

When a Service component is actually created, for either of these reasons, all that the system actually does is instantiate the component and call its onCreate() and any other appropriate callbacks on the main thread. It is up to the Service to implement these with the appropriate behavior, such as creating a secondary thread in which it does its work.

Note that because Service itself is so simple, you can make your interaction with it as simple or complicated as you want: from treating it as a local Java object that you make direct method calls on (as illustrated by Local Service Sample), to providing a full remoteable interface using AIDL.

Service Lifecycle

There are two reasons that a service can be run by the system. If someone calls Context.startService() then the system will retrieve the service (creating it and calling its onCreate() method if needed) and then call its onStartCommand(Intent, int, int) method with the arguments supplied by the client. The service will at this point continue running until Context.stopService() or stopSelf() is called. Note that multiple calls to Context.startService() do not nest (though they do result in multiple corresponding calls to onStartCommand()), so no matter how many times it is started a service will be stopped once Context.stopService() or stopSelf() is called; however, services can use their stopSelf(int) method to ensure the service is not stopped until started intents have been processed.

For started services, there are two additional major modes of operation they can decide to run in, depending on the value they return from onStartCommand(): START_STICKY is used for services that are explicitly started and stopped as needed, while START_NOT_STICKY or START_REDELIVER_INTENT are used for services that should only remain running while processing any commands sent to them. See the linked documentation for more detail on the semantics.

Clients can also use Context.bindService() to obtain a persistent connection to a service. This likewise creates the service if it is not already running (calling onCreate() while doing so), but does not call onStartCommand(). The client will receive the IBinder object that the service returns from its onBind(Intent) method, allowing the client to then make calls back to the service. The service will remain running as long as the connection is established (whether or not the client retains a reference on the service's IBinder). Usually the IBinder returned is for a complex interface that has been written in aidl.

A service can be both started and have connections bound to it. In such a case, the system will keep the service running as long as either it is started or there are one or more connections to it with the Context.BIND_AUTO_CREATE flag. Once neither of these situations hold, the service's onDestroy() method is called and the service is effectively terminated. All cleanup (stopping threads, unregistering receivers) should be complete upon returning from onDestroy().

Permissions

Global access to a service can be enforced when it is declared in its manifest's <service> tag. By doing so, other applications will need to declare a corresponding <uses-permission> element in their own manifest to be able to start, stop, or bind to the service.

As of Build.VERSION_CODES.GINGERBREAD, when using Context.startService(Intent), you can also set Intent.FLAG_GRANT_READ_URI_PERMISSION and/or Intent.FLAG_GRANT_WRITE_URI_PERMISSION on the Intent. This will grant the Service temporary access to the specific URIs in the Intent. Access will remain until the Service has called stopSelf(int) for that start command or a later one, or until the Service has been completely stopped. This works for granting access to the other apps that have not requested the permission protecting the Service, or even when the Service is not exported at all.

In addition, a service can protect individual IPC calls into it with permissions, by calling the ContextWrapper.checkCallingPermission(String) method before executing the implementation of that call.

See the Security and Permissions document for more information on permissions and security in general.

Process Lifecycle

A started service can use the startForeground(int,Notification) API to put the service in a foreground state, where the system considers it to be something the user is actively aware of and thus not a candidate for killing when low on memory. (It is still theoretically possible for the service to be killed under extreme memory pressure from the current foreground application, but in practice this should not be a concern.)

Note this means that most of the time your service is running, it may be killed by the system if it is under heavy memory pressure. If this happens, the system will later try to restart the service. An important consequence of this is that if you implement onStartCommand() to schedule work to be done asynchronously or in another thread, then you may want to use START_FLAG_REDELIVERY to have the system re-deliver an Intent for you so that it does not get lost if your service is killed while processing it.

Other application components running in the same process as the service (such as an Activity) can, of course, increase the importance of the overall process beyond just the importance of the service itself.

Local Service Sample

One of the most common uses of a Service is as a secondary component running alongside other parts of an application, in the same process as the rest of the components. All components of an .apk run in the same process unless explicitly stated otherwise, so this is a typical situation.

When used in this way, by assuming the components are in the same process, you can greatly simplify the interaction between them: clients of the service can simply cast the IBinder they receive from it to a concrete class published by the service.

An example of this use of a Service is shown here. First is the Service itself, publishing a custom class when bound:

public class LocalService extends Service {
    private NotificationManager mNM;

    // Unique Identification Number for the Notification.
    // We use it on Notification start, and to cancel it.
    private int NOTIFICATION = R.string.local_service_started;

    /**
     * Class for clients to access.  Because we know this service always
     * runs in the same process as its clients, we don't need to deal with
     * IPC.
     */
    public class LocalBinder extends Binder {
        LocalService getService() {
            return LocalService.this;
        }
    }

    @Override
    public void onCreate() {
        mNM = (NotificationManager)getSystemService(NOTIFICATION_SERVICE);

        // Display a notification about us starting.  We put an icon in the status bar.
        showNotification();
    }

    @Override
    public int onStartCommand(Intent intent, int flags, int startId) {
        Log.i("LocalService", "Received start id " + startId + ": " + intent);
        return START_NOT_STICKY;
    }

    @Override
    public void onDestroy() {
        // Cancel the persistent notification.
        mNM.cancel(NOTIFICATION);

        // Tell the user we stopped.
        Toast.makeText(this, R.string.local_service_stopped, Toast.LENGTH_SHORT).show();
    }

    @Override
    public IBinder onBind(Intent intent) {
        return mBinder;
    }

    // This is the object that receives interactions from clients.  See
    // RemoteService for a more complete example.
    private final IBinder mBinder = new LocalBinder();

    /**
     * Show a notification while this service is running.
     */
    private void showNotification() {
        // In this sample, we'll use the same text for the ticker and the expanded notification
        CharSequence text = getText(R.string.local_service_started);

        // The PendingIntent to launch our activity if the user selects this notification
        PendingIntent contentIntent = PendingIntent.getActivity(this, 0,
                new Intent(this, LocalServiceActivities.Controller.class), 0);

        // Set the info for the views that show in the notification panel.
        Notification notification = new Notification.Builder(this)
                .setSmallIcon(R.drawable.stat_sample)  // the status icon
                .setTicker(text)  // the status text
                .setWhen(System.currentTimeMillis())  // the time stamp
                .setContentTitle(getText(R.string.local_service_label))  // the label of the entry
                .setContentText(text)  // the contents of the entry
                .setContentIntent(contentIntent)  // The intent to send when the entry is clicked
                .build();

        // Send the notification.
        mNM.notify(NOTIFICATION, notification);
    }
}

With that done, one can now write client code that directly accesses the running service, such as:

/**
 * Example of binding and unbinding to the local service.
 * bind to, receiving an object through which it can communicate with the service.
 *
 * Note that this is implemented as an inner class only keep the sample
 * all together; typically this code would appear in some separate class.
 */
public static class Binding extends Activity {
    // Don't attempt to unbind from the service unless the client has received some
    // information about the service's state.
    private boolean mShouldUnbind;

    // To invoke the bound service, first make sure that this value
    // is not null.
    private LocalService mBoundService;

    private ServiceConnection mConnection = new ServiceConnection() {
        public void onServiceConnected(ComponentName className, IBinder service) {
            // This is called when the connection with the service has been
            // established, giving us the service object we can use to
            // interact with the service.  Because we have bound to a explicit
            // service that we know is running in our own process, we can
            // cast its IBinder to a concrete class and directly access it.
            mBoundService = ((LocalService.LocalBinder)service).getService();

            // Tell the user about this for our demo.
            Toast.makeText(Binding.this, R.string.local_service_connected,
                    Toast.LENGTH_SHORT).show();
        }

        public void onServiceDisconnected(ComponentName className) {
            // This is called when the connection with the service has been
            // unexpectedly disconnected -- that is, its process crashed.
            // Because it is running in our same process, we should never
            // see this happen.
            mBoundService = null;
            Toast.makeText(Binding.this, R.string.local_service_disconnected,
                    Toast.LENGTH_SHORT).show();
        }
    };

    void doBindService() {
        // Attempts to establish a connection with the service.  We use an
        // explicit class name because we want a specific service
        // implementation that we know will be running in our own process
        // (and thus won't be supporting component replacement by other
        // applications).
        if (bindService(new Intent(Binding.this, LocalService.class),
                mConnection, Context.BIND_AUTO_CREATE)) {
            mShouldUnbind = true;
        } else {
            Log.e("MY_APP_TAG", "Error: The requested service doesn't " +
                    "exist, or this client isn't allowed access to it.");
        }
    }

    void doUnbindService() {
        if (mShouldUnbind) {
            // Release information about the service's state.
            unbindService(mConnection);
            mShouldUnbind = false;
        }
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        doUnbindService();
    }

Remote Messenger Service Sample

If you need to be able to write a Service that can perform complicated communication with clients in remote processes (beyond simply the use of Context.startService to send commands to it), then you can use the Messenger class instead of writing full AIDL files.

An example of a Service that uses Messenger as its client interface is shown here. First is the Service itself, publishing a Messenger to an internal Handler when bound:

public class MessengerService extends Service {
    /** For showing and hiding our notification. */
    NotificationManager mNM;
    /** Keeps track of all current registered clients. */
    ArrayList<Messenger> mClients = new ArrayList<Messenger>();
    /** Holds last value set by a client. */
    int mValue = 0;

    /**
     * Command to the service to register a client, receiving callbacks
     * from the service.  The Message's replyTo field must be a Messenger of
     * the client where callbacks should be sent.
     */
    static final int MSG_REGISTER_CLIENT = 1;

    /**
     * Command to the service to unregister a client, ot stop receiving callbacks
     * from the service.  The Message's replyTo field must be a Messenger of
     * the client as previously given with MSG_REGISTER_CLIENT.
     */
    static final int MSG_UNREGISTER_CLIENT = 2;

    /**
     * Command to service to set a new value.  This can be sent to the
     * service to supply a new value, and will be sent by the service to
     * any registered clients with the new value.
     */
    static final int MSG_SET_VALUE = 3;

    /**
     * Handler of incoming messages from clients.
     */
    class IncomingHandler extends Handler {
        @Override
        public void handleMessage(Message msg) {
            switch (msg.what) {
                case MSG_REGISTER_CLIENT:
                    mClients.add(msg.replyTo);
                    break;
                case MSG_UNREGISTER_CLIENT:
                    mClients.remove(msg.replyTo);
                    break;
                case MSG_SET_VALUE:
                    mValue = msg.arg1;
                    for (int i=mClients.size()-1; i>=0; i--) {
                        try {
                            mClients.get(i).send(Message.obtain(null,
                                    MSG_SET_VALUE, mValue, 0));
                        } catch (RemoteException e) {
                            // The client is dead.  Remove it from the list;
                            // we are going through the list from back to front
                            // so this is safe to do inside the loop.
                            mClients.remove(i);
                        }
                    }
                    break;
                default:
                    super.handleMessage(msg);
            }
        }
    }

    /**
     * Target we publish for clients to send messages to IncomingHandler.
     */
    final Messenger mMessenger = new Messenger(new IncomingHandler());

    @Override
    public void onCreate() {
        mNM = (NotificationManager)getSystemService(NOTIFICATION_SERVICE);

        // Display a notification about us starting.
        showNotification();
    }

    @Override
    public void onDestroy() {
        // Cancel the persistent notification.
        mNM.cancel(R.string.remote_service_started);

        // Tell the user we stopped.
        Toast.makeText(this, R.string.remote_service_stopped, Toast.LENGTH_SHORT).show();
    }

    /**
     * When binding to the service, we return an interface to our messenger
     * for sending messages to the service.
     */
    @Override
    public IBinder onBind(Intent intent) {
        return mMessenger.getBinder();
    }

    /**
     * Show a notification while this service is running.
     */
    private void showNotification() {
        // In this sample, we'll use the same text for the ticker and the expanded notification
        CharSequence text = getText(R.string.remote_service_started);

        // The PendingIntent to launch our activity if the user selects this notification
        PendingIntent contentIntent = PendingIntent.getActivity(this, 0,
                new Intent(this, Controller.class), 0);

        // Set the info for the views that show in the notification panel.
        Notification notification = new Notification.Builder(this)
                .setSmallIcon(R.drawable.stat_sample)  // the status icon
                .setTicker(text)  // the status text
                .setWhen(System.currentTimeMillis())  // the time stamp
                .setContentTitle(getText(R.string.local_service_label))  // the label of the entry
                .setContentText(text)  // the contents of the entry
                .setContentIntent(contentIntent)  // The intent to send when the entry is clicked
                .build();

        // Send the notification.
        // We use a string id because it is a unique number.  We use it later to cancel.
        mNM.notify(R.string.remote_service_started, notification);
    }
}

If we want to make this service run in a remote process (instead of the standard one for its .apk), we can use android:process in its manifest tag to specify one:

<service android:name=".app.MessengerService"
        android:process=":remote" />

Note that the name "remote" chosen here is arbitrary, and you can use other names if you want additional processes. The ':' prefix appends the name to your package's standard process name.

With that done, clients can now bind to the service and send messages to it. Note that this allows clients to register with it to receive messages back as well:

/**
 * Example of binding and unbinding to the remote service.
 * This demonstrates the implementation of a service which the client will
 * bind to, interacting with it through an aidl interface.
 * 
 * Note that this is implemented as an inner class only keep the sample
 * all together; typically this code would appear in some separate class.
 */
public static class Binding extends Activity {
    /** Messenger for communicating with service. */
    Messenger mService = null;
    /** Flag indicating whether we have called bind on the service. */
    boolean mIsBound;
    /** Some text view we are using to show state information. */
    TextView mCallbackText;

    /**
     * Handler of incoming messages from service.
     */
    class IncomingHandler extends Handler {
        @Override
        public void handleMessage(Message msg) {
            switch (msg.what) {
                case MessengerService.MSG_SET_VALUE:
                    mCallbackText.setText("Received from service: " + msg.arg1);
                    break;
                default:
                    super.handleMessage(msg);
            }
        }
    }

    /**
     * Target we publish for clients to send messages to IncomingHandler.
     */
    final Messenger mMessenger = new Messenger(new IncomingHandler());

    /**
     * Class for interacting with the main interface of the service.
     */
    private ServiceConnection mConnection = new ServiceConnection() {
        public void onServiceConnected(ComponentName className,
                IBinder service) {
            // This is called when the connection with the service has been
            // established, giving us the service object we can use to
            // interact with the service.  We are communicating with our
            // service through an IDL interface, so get a client-side
            // representation of that from the raw service object.
            mService = new Messenger(service);
            mCallbackText.setText("Attached.");

            // We want to monitor the service for as long as we are
            // connected to it.
            try {
                Message msg = Message.obtain(null,
                        MessengerService.MSG_REGISTER_CLIENT);
                msg.replyTo = mMessenger;
                mService.send(msg);

                // Give it some value as an example.
                msg = Message.obtain(null,
                        MessengerService.MSG_SET_VALUE, this.hashCode(), 0);
                mService.send(msg);
            } catch (RemoteException e) {
                // In this case the service has crashed before we could even
                // do anything with it; we can count on soon being
                // disconnected (and then reconnected if it can be restarted)
                // so there is no need to do anything here.
            }

            // As part of the sample, tell the user what happened.
            Toast.makeText(Binding.this, R.string.remote_service_connected,
                    Toast.LENGTH_SHORT).show();
        }

        public void onServiceDisconnected(ComponentName className) {
            // This is called when the connection with the service has been
            // unexpectedly disconnected -- that is, its process crashed.
            mService = null;
            mCallbackText.setText("Disconnected.");

            // As part of the sample, tell the user what happened.
            Toast.makeText(Binding.this, R.string.remote_service_disconnected,
                    Toast.LENGTH_SHORT).show();
        }
    };

    void doBindService() {
        // Establish a connection with the service.  We use an explicit
        // class name because there is no reason to be able to let other
        // applications replace our component.
        bindService(new Intent(Binding.this, 
                MessengerService.class), mConnection, Context.BIND_AUTO_CREATE);
        mIsBound = true;
        mCallbackText.setText("Binding.");
    }

    void doUnbindService() {
        if (mIsBound) {
            // If we have received the service, and hence registered with
            // it, then now is the time to unregister.
            if (mService != null) {
                try {
                    Message msg = Message.obtain(null,
                            MessengerService.MSG_UNREGISTER_CLIENT);
                    msg.replyTo = mMessenger;
                    mService.send(msg);
                } catch (RemoteException e) {
                    // There is nothing special we need to do if the service
                    // has crashed.
                }
            }

            // Detach our existing connection.
            unbindService(mConnection);
            mIsBound = false;
            mCallbackText.setText("Unbinding.");
        }
    }

Summary

Inherited methods

Set the base context for this ContextWrapper.

Variation of bindService(Intent, BindServiceFlags, Executor, ServiceConnection) that, in the specific case of isolated services, allows the caller to generate multiple instances of a service from a single component declaration.

Same as bindService(Intent, ServiceConnection, int) with executor to control ServiceConnection callbacks.

See bindService(Intent,ServiceConnection,int) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

Connects to an application service, creating it if needed.

See bindService(Intent,int,Executor,ServiceConnection) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

Binds to a service in the given user in the same manner as bindService(Intent, BindServiceFlags, Executor, ServiceConnection).

See bindServiceAsUser(Intent,ServiceConnection,int,UserHandle) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

Determine whether the calling process of an IPC or you have been granted a particular permission.

Determine whether the calling process of an IPC or you has been granted permission to access a specific URI.

Determine whether the calling process of an IPC or you has been granted permission to access a list of URIs.

Determine whether the calling process of an IPC you are handling has been granted a particular permission.

Determine whether the calling process and uid has been granted permission to access a specific URI.

Determine whether the calling process and uid has been granted permission to access a list of URIs.

Determine whether a particular process and uid has been granted permission to access a specific content URI.

Determine whether the given permission is allowed for a particular process and user ID running in the system.

Determine whether you have been granted a particular permission.

Check both a Uri and normal permission.

Determine whether a particular process and uid has been granted permission to access a specific URI.

Determine whether a particular process and uid has been granted permission to access a list of URIs.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

Return a new Context object for the current Context but attribute to a different tag.

Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration.

Creates a context with specific properties and behaviors.

Return a new Context object for the given split name.

Returns a new Context object from the current context but with device association given by the deviceId.

Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage.

Returns a new Context object from the current context but with resources adjusted to match the metrics of display.

Return a new Context object for the given application name.

Creates a Context for a non-activity window.

Creates a Context for a non-activity window on the given Display.

Returns an array of strings naming the private databases associated with this Context's application package.

Delete an existing private SQLiteDatabase associated with this Context's application package.

Delete the given private file associated with this Context's application package.

Delete an existing shared preferences file.

If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a SecurityException.

If the calling process of an IPC or you has not been granted permission to access a specific URI, throw SecurityException.

If the calling process of an IPC you are handling has not been granted a particular permission, throw a SecurityException.

If the calling process and uid has not been granted permission to access a specific URI, throw SecurityException.

If the given permission is not allowed for a particular process and user ID running in the system, throw a SecurityException.

Enforce both a Uri and normal permission.

If a particular process and uid has not been granted permission to access a specific URI, throw SecurityException.

Returns an array of strings naming the private files associated with this Context's application package.

Return the context of the single, global Application object of the current process.

Return the full application info for this context's package.

Returns an AssetManager instance for the application's package.

Attribution can be used in complex apps to logically separate parts of the app.

Returns the absolute path to the application specific cache directory on the filesystem.

Return a class loader you can use to retrieve classes in this package.

Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.

Return a ContentResolver instance for your application's package.

Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored.

Returns the absolute path on the filesystem where a database created with openOrCreateDatabase(String, int, CursorFactory) is stored.

Gets the device ID this context is associated with.

Retrieve, creating if needed, a new directory in which the application can place its own custom data files.

Get the display this context is associated with.

Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns.

Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place cache files it owns.

Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns.

Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns.

This method is deprecated. These directories still exist and are scanned, but developers are encouraged to migrate to inserting content into a MediaStore collection directly, as any app can contribute new media to MediaStore with no permissions required, starting in Build.VERSION_CODES.Q.

Returns the absolute path on the filesystem where a file created with openFileOutput(String, int) is stored.

Returns the absolute path to the directory on the filesystem where files created with openFileOutput(String, int) are stored.

Return an Executor that will run enqueued tasks on the main thread associated with this context.

Return the Looper for the main thread of the current process.

Returns the absolute path to the directory on the filesystem similar to getFilesDir().

Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found.

Returns absolute paths to application-specific directories on all shared/external storage devices where the application's OBB files (if there are any) can be found.

Return the package name that should be used for AppOpsManager calls from this context, so that app ops manager's uid verification will work with the name.

Return the full path to this context's primary Android package.

Return PackageManager instance to find global package information.

Return the name of this application's package.

Return the full path to this context's primary Android package.

Return the set of parameters which this Context was created with, if it was created via createContext(ContextParams).

Returns a Resources instance for the application's package.

Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values.

Return the handle to a system-level service by name.

Gets the name of the system-level service that is represented by the specified class.

Return the Theme object associated with this Context.

This method is deprecated. Use WallpaperManager.get() instead.

This method is deprecated. Use WallpaperManager.getDesiredMinimumHeight() instead.

This method is deprecated. Use WallpaperManager.getDesiredMinimumWidth() instead.

Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider.

Indicates if the storage APIs of this Context are backed by device-protected storage.

Indicates whether this Context is restricted.

Returns true if the context is a UI context which can access UI components such as WindowManager, LayoutInflater or WallpaperManager.

Move an existing database file from the given source storage context to this context.

Move an existing shared preferences file from the given source storage context to this context.

Open a private file associated with this Context's application package for reading.

Open a private file associated with this Context's application package for writing.

Open a new private SQLiteDatabase associated with this Context's application package.

Open a new private SQLiteDatabase associated with this Context's application package.

This method is deprecated. Use WallpaperManager.peek() instead.

Rebind an application service with updated bind service flags

Add a new ComponentCallbacks to the base application of the Context, which will be called at the same times as the ComponentCallbacks methods of activities and other components are called.

Adds a new device ID changed listener to the Context, which will be called when the device association is changed by the system.

Register a BroadcastReceiver to be run in the main activity thread.

Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps.

Register to receive intent broadcasts, to run in the context of scheduler.

Register to receive intent broadcasts, to run in the context of scheduler.

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

Triggers the revocation of one or more permissions for the calling package.

Remove all permissions to access a particular content provider Uri that were previously added with grantUriPermission(String, Uri, int) or any other mechanism.

Remove permissions to access a particular content provider Uri that were previously added with grantUriPermission(String, Uri, int) for a specific target package.

Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.

Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.

Broadcast the given intent to all interested BroadcastReceivers.

Version of sendBroadcast(Intent) that allows you to specify the user the broadcast will be sent to.

Version of sendBroadcast(Intent,String) that allows you to specify the user the broadcast will be sent to.

Version of sendOrderedBroadcast(Intent,String,BroadcastReceiver,Handler,int,String,Bundle) that allows you to specify the App Op to enforce restrictions on which receivers the broadcast will be sent to.

Version of sendBroadcast(Intent) that allows you to receive data back from the broadcast.

Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.

Version of sendBroadcast(Intent) that allows you to receive data back from the broadcast.

Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.

Version of sendOrderedBroadcast(Intent,String,BroadcastReceiver,Handler,int,String,Bundle) that allows you to specify the user the broadcast will be sent to.

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

Set the base theme for this context.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

Launch multiple new activities.

Same as startActivities(Intent[],Bundle) with no options specified.

Same as startActivity(Intent,Bundle) with no options specified.

Launch a new activity.

Similar to startService(Intent), but with an implicit promise that the Service will call startForeground(int, android.app.Notification) once it begins running.

Start executing an Instrumentation class.

Same as startIntentSender(IntentSender,Intent,int,int,int,Bundle) with no options specified.

Like startActivity(Intent,Bundle), but taking a IntentSender to start.

Request that a given application service be started.

Request that a given application service be stopped.

Disconnect from an application service.

Remove a ComponentCallbacks object that was previously registered with registerComponentCallbacks(ComponentCallbacks).

Removes a device ID changed listener from the Context.

Unregister a previously registered BroadcastReceiver.

Perform a batch update of existing bindings.

For a service previously bound with bindService(Intent, BindServiceFlags, Executor, ServiceConnection) or a related method, change how the system manages that service's process in relation to other processes.

Variation of bindService(Intent, BindServiceFlags, Executor, ServiceConnection) that, in the specific case of isolated services, allows the caller to generate multiple instances of a service from a single component declaration.

See bindIsolatedService(Intent,int,String,Executor,ServiceConnection) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

Same as bindService(Intent, ServiceConnection, int) with executor to control ServiceConnection callbacks.

See bindService(Intent,ServiceConnection,int) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

Connects to an application service, creating it if needed.

See bindService(Intent,int,Executor,ServiceConnection) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

Binds to a service in the given user in the same manner as bindService(Intent, BindServiceFlags, Executor, ServiceConnection).

See bindServiceAsUser(Intent,ServiceConnection,int,UserHandle) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

Determine whether the calling process of an IPC or you have been granted a particular permission.

Determine whether the calling process of an IPC or you has been granted permission to access a specific URI.

Determine whether the calling process of an IPC or you has been granted permission to access a list of URIs.

Determine whether the calling process of an IPC you are handling has been granted a particular permission.

Determine whether the calling process and uid has been granted permission to access a specific URI.

Determine whether the calling process and uid has been granted permission to access a list of URIs.

Determine whether a particular process and uid has been granted permission to access a specific content URI.

Determine whether the given permission is allowed for a particular process and user ID running in the system.

Determine whether you have been granted a particular permission.

Check both a Uri and normal permission.

Determine whether a particular process and uid has been granted permission to access a specific URI.

Determine whether a particular process and uid has been granted permission to access a list of URIs.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

Return a new Context object for the current Context but attribute to a different tag.

Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration.

Creates a context with specific properties and behaviors.

Return a new Context object for the given split name.

Returns a new Context object from the current context but with device association given by the deviceId.

Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage.

Returns a new Context object from the current context but with resources adjusted to match the metrics of display.

Return a new Context object for the given application name.

Creates a Context for a non-activity window.

Creates a Context for a non-activity window on the given Display.

Returns an array of strings naming the private databases associated with this Context's application package.

Delete an existing private SQLiteDatabase associated with this Context's application package.

Delete the given private file associated with this Context's application package.

Delete an existing shared preferences file.

If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a SecurityException.

If the calling process of an IPC or you has not been granted permission to access a specific URI, throw SecurityException.

If the calling process of an IPC you are handling has not been granted a particular permission, throw a SecurityException.

If the calling process and uid has not been granted permission to access a specific URI, throw SecurityException.

If the given permission is not allowed for a particular process and user ID running in the system, throw a SecurityException.

Enforce both a Uri and normal permission.

If a particular process and uid has not been granted permission to access a specific URI, throw SecurityException.

Returns an array of strings naming the private files associated with this Context's application package.

Return the context of the single, global Application object of the current process.

Return the full application info for this context's package.

Returns an AssetManager instance for the application's package.

Attribution can be used in complex apps to logically separate parts of the app.

Returns the absolute path to the application specific cache directory on the filesystem.

Return a class loader you can use to retrieve classes in this package.

Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.

Returns a color associated with a particular resource ID and styled for the current theme.

Returns a color state list associated with a particular resource ID and styled for the current theme.

Return a ContentResolver instance for your application's package.

Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored.

Returns the absolute path on the filesystem where a database created with openOrCreateDatabase(String, int, CursorFactory) is stored.

Gets the device ID this context is associated with.

Retrieve, creating if needed, a new directory in which the application can place its own custom data files.

Get the display this context is associated with.

Returns a drawable object associated with a particular resource ID and styled for the current theme.

Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns.

Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place cache files it owns.

Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns.

Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns.

This method was deprecated in API level 30. These directories still exist and are scanned, but developers are encouraged to migrate to inserting content into a MediaStore collection directly, as any app can contribute new media to MediaStore with no permissions required, starting in Build.VERSION_CODES.Q.

Returns the absolute path on the filesystem where a file created with openFileOutput(String, int) is stored.

Returns the absolute path to the directory on the filesystem where files created with openFileOutput(String, int) are stored.

Return an Executor that will run enqueued tasks on the main thread associated with this context.

Return the Looper for the main thread of the current process.

Returns the absolute path to the directory on the filesystem similar to getFilesDir().

Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found.

Returns absolute paths to application-specific directories on all shared/external storage devices where the application's OBB files (if there are any) can be found.

Return the package name that should be used for AppOpsManager calls from this context, so that app ops manager's uid verification will work with the name.

Return the full path to this context's primary Android package.

Return PackageManager instance to find global package information.

Return the name of this application's package.

Return the full path to this context's primary Android package.

Return the set of parameters which this Context was created with, if it was created via createContext(ContextParams).

Returns a Resources instance for the application's package.

Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values.

Returns a localized string from the application's package's default string table.

Returns a localized formatted string from the application's package's default string table, substituting the format arguments as defined in Formatter and String.format(String, Object).

Return the handle to a system-level service by class.

Return the handle to a system-level service by name.

Gets the name of the system-level service that is represented by the specified class.

Return a localized, styled CharSequence from the application's package's default string table.

Return the Theme object associated with this Context.

Gets the list of bind flags that may be updated (i.e.

This method was deprecated in API level 15. Use WallpaperManager.get() instead.

This method was deprecated in API level 15. Use WallpaperManager.getDesiredMinimumHeight() instead.

This method was deprecated in API level 15. Use WallpaperManager.getDesiredMinimumWidth() instead.

Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider.

Indicates if the storage APIs of this Context are backed by device-protected storage.

Indicates whether this Context is restricted.

Returns true if the context is a UI context which can access UI components such as WindowManager, LayoutInflater or WallpaperManager.

Move an existing database file from the given source storage context to this context.

Move an existing shared preferences file from the given source storage context to this context.

Retrieve styled attribute information in this Context's theme.

Retrieve styled attribute information in this Context's theme.

Retrieve styled attribute information in this Context's theme.

Retrieve styled attribute information in this Context's theme.

Open a private file associated with this Context's application package for reading.

Open a private file associated with this Context's application package for writing.

Open a new private SQLiteDatabase associated with this Context's application package.

Open a new private SQLiteDatabase associated with this Context's application package.

This method was deprecated in API level 15. Use WallpaperManager.peek() instead.

Rebind an application service with updated bind service flags

Add a new ComponentCallbacks to the base application of the Context, which will be called at the same times as the ComponentCallbacks methods of activities and other components are called.

Adds a new device ID changed listener to the Context, which will be called when the device association is changed by the system.

Register a BroadcastReceiver to be run in the main activity thread.

Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps.

Register to receive intent broadcasts, to run in the context of scheduler.

Register to receive intent broadcasts, to run in the context of scheduler.

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

Triggers the asynchronous revocation of a runtime permission.

Triggers the revocation of one or more permissions for the calling package.

Remove all permissions to access a particular content provider Uri that were previously added with grantUriPermission(String, Uri, int) or any other mechanism.

Remove permissions to access a particular content provider Uri that were previously added with grantUriPermission(String, Uri, int) for a specific target package.

Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.

Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.

Broadcast the given intent to all interested BroadcastReceivers.

Version of sendBroadcast(Intent) that allows you to specify the user the broadcast will be sent to.

Version of sendBroadcast(Intent,String) that allows you to specify the user the broadcast will be sent to.

Broadcast the given intent to all interested BroadcastReceivers, allowing an array of required permissions to be enforced.

Version of sendOrderedBroadcast(Intent,String,BroadcastReceiver,Handler,int,String,Bundle) that allows you to specify the App Op to enforce restrictions on which receivers the broadcast will be sent to.

Version of sendBroadcast(Intent) that allows you to receive data back from the broadcast.

Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.

Version of sendBroadcast(Intent) that allows you to receive data back from the broadcast.

Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.

Version of sendOrderedBroadcast(Intent,String,BroadcastReceiver,Handler,int,String,Bundle) that allows you to specify the user the broadcast will be sent to.

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

This method was deprecated in API level 31. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

Set the base theme for this context.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

Launch multiple new activities.

Same as startActivities(Intent[],Bundle) with no options specified.

Same as startActivity(Intent,Bundle) with no options specified.

Launch a new activity.

Similar to startService(Intent), but with an implicit promise that the Service will call startForeground(int, android.app.Notification) once it begins running.

Start executing an Instrumentation class.

Same as startIntentSender(IntentSender,Intent,int,int,int,Bundle) with no options specified.

Like startActivity(Intent,Bundle), but taking a IntentSender to start.

Request that a given application service be started.

Request that a given application service be stopped.

Disconnect from an application service.

Remove a ComponentCallbacks object that was previously registered with registerComponentCallbacks(ComponentCallbacks).

Removes a device ID changed listener from the Context.

Unregister a previously registered BroadcastReceiver.

Perform a batch update of existing bindings.

For a service previously bound with bindService(Intent, BindServiceFlags, Executor, ServiceConnection) or a related method, change how the system manages that service's process in relation to other processes.

Constants

public static final int START_CONTINUATION_MASK

public static final int START_FLAG_REDELIVERY

public static final int START_FLAG_RETRY

public static final int START_NOT_STICKY

public static final int START_REDELIVER_INTENT

public static final int START_STICKY

public static final int START_STICKY_COMPATIBILITY

public static final int STOP_FOREGROUND_DETACH

public static final int STOP_FOREGROUND_LEGACY

public static final int STOP_FOREGROUND_REMOVE

Public constructors

public Service ()

Public methods

public final Application getApplication ()

getForegroundServiceType

public final int getForegroundServiceType ()

If the service has become a foreground service by calling startForeground(int,Notification) or startForeground(int,Notification,int), getForegroundServiceType() returns the current foreground service type.

If there is no foregroundServiceType specified in manifest, ServiceInfo.FOREGROUND_SERVICE_TYPE_NONE is returned.

If the service is not a foreground service, ServiceInfo.FOREGROUND_SERVICE_TYPE_NONE is returned.

• ServiceInfo.FOREGROUND_SERVICE_TYPE_MANIFEST
• ServiceInfo.FOREGROUND_SERVICE_TYPE_NONE
• ServiceInfo.FOREGROUND_SERVICE_TYPE_DATA_SYNC
• ServiceInfo.FOREGROUND_SERVICE_TYPE_MEDIA_PLAYBACK
• ServiceInfo.FOREGROUND_SERVICE_TYPE_PHONE_CALL
• ServiceInfo.FOREGROUND_SERVICE_TYPE_LOCATION
• ServiceInfo.FOREGROUND_SERVICE_TYPE_CONNECTED_DEVICE
• ServiceInfo.FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION
• ServiceInfo.FOREGROUND_SERVICE_TYPE_CAMERA
• ServiceInfo.FOREGROUND_SERVICE_TYPE_MICROPHONE
• ServiceInfo.FOREGROUND_SERVICE_TYPE_HEALTH
• ServiceInfo.FOREGROUND_SERVICE_TYPE_REMOTE_MESSAGING
• ServiceInfo.FOREGROUND_SERVICE_TYPE_SYSTEM_EXEMPTED
• ServiceInfo.FOREGROUND_SERVICE_TYPE_SHORT_SERVICE
• ServiceInfo.FOREGROUND_SERVICE_TYPE_MEDIA_PROCESSING
• ServiceInfo.FOREGROUND_SERVICE_TYPE_SPECIAL_USE

public abstract IBinder onBind (Intent intent)

public void onConfigurationChanged (Configuration newConfig)

public void onCreate ()

public void onDestroy ()

public void onLowMemory ()

public void onRebind (Intent intent)

public void onStart (Intent intent, 
                int startId)

onStartCommand

public int onStartCommand (Intent intent, 
                int flags, 
                int startId)

Called by the system every time a client explicitly starts the service by calling Context.startService(Intent), providing the arguments it supplied and a unique integer token representing the start request. Do not call this method directly.

For backwards compatibility, the default implementation calls onStart(Intent, int) and returns either START_STICKY or START_STICKY_COMPATIBILITY.

Note that the system calls this on your service's main thread. A service's main thread is the same thread where UI operations take place for Activities running in the same process. You should always avoid stalling the main thread's event loop. When doing long-running operations, network calls, or heavy disk I/O, you should kick off a new thread, or use AsyncTask.

• START_FLAG_REDELIVERY
• START_FLAG_RETRY

• START_STICKY_COMPATIBILITY
• START_STICKY
• START_NOT_STICKY
• START_REDELIVER_INTENT

public void onTaskRemoved (Intent rootIntent)

onTimeout

public void onTimeout (int startId, 
                int fgsType)

Callback called when a particular foreground service type has timed out.

This callback is meant to give the app a small grace period of a few seconds to finish the foreground service of the associated type - if it fails to do so, the app will crash.

The foreground service of the associated type can be stopped within the time limit by stopSelf(), Context.stopService(android.content.Intent) or their overloads. stopForeground(int) can be used as well, which demotes the service to a "background" service, which will soon be stopped by the system.

The specific time limit for each type (if one exists) is mentioned in the documentation for that foreground service type. See dataSync for example.

Note: time limits are restricted to a rolling 24-hour window - for example, if a foreground service type has a time limit of 6 hours, that time counter begins as soon as the foreground service starts. This time limit will only be reset once every 24 hours or if the app comes into the foreground state.

• ServiceInfo.FOREGROUND_SERVICE_TYPE_MANIFEST
• ServiceInfo.FOREGROUND_SERVICE_TYPE_NONE
• ServiceInfo.FOREGROUND_SERVICE_TYPE_DATA_SYNC
• ServiceInfo.FOREGROUND_SERVICE_TYPE_MEDIA_PLAYBACK
• ServiceInfo.FOREGROUND_SERVICE_TYPE_PHONE_CALL
• ServiceInfo.FOREGROUND_SERVICE_TYPE_LOCATION
• ServiceInfo.FOREGROUND_SERVICE_TYPE_CONNECTED_DEVICE
• ServiceInfo.FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION
• ServiceInfo.FOREGROUND_SERVICE_TYPE_CAMERA
• ServiceInfo.FOREGROUND_SERVICE_TYPE_MICROPHONE
• ServiceInfo.FOREGROUND_SERVICE_TYPE_HEALTH
• ServiceInfo.FOREGROUND_SERVICE_TYPE_REMOTE_MESSAGING
• ServiceInfo.FOREGROUND_SERVICE_TYPE_SYSTEM_EXEMPTED
• ServiceInfo.FOREGROUND_SERVICE_TYPE_SHORT_SERVICE
• ServiceInfo.FOREGROUND_SERVICE_TYPE_MEDIA_PROCESSING
• ServiceInfo.FOREGROUND_SERVICE_TYPE_SPECIAL_USE

public void onTimeout (int startId)

onTrimMemory

public void onTrimMemory (int level)

Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process. You should never compare to exact values of the level, since new intermediate values may be added -- you will typically want to compare if the value is greater or equal to a level you are interested in.

To retrieve the processes current trim level at any point, you can use ActivityManager.getMyMemoryState(RunningAppProcessInfo).

• ComponentCallbacks2.TRIM_MEMORY_COMPLETE
• ComponentCallbacks2.TRIM_MEMORY_MODERATE
• ComponentCallbacks2.TRIM_MEMORY_BACKGROUND
• ComponentCallbacks2.TRIM_MEMORY_UI_HIDDEN
• ComponentCallbacks2.TRIM_MEMORY_RUNNING_CRITICAL
• ComponentCallbacks2.TRIM_MEMORY_RUNNING_LOW
• ComponentCallbacks2.TRIM_MEMORY_RUNNING_MODERATE

public boolean onUnbind (Intent intent)

public final void startForeground (int id, 
                Notification notification)

startForeground

public final void startForeground (int id, 
                Notification notification, 
                int foregroundServiceType)

An overloaded version of startForeground(int,Notification) with additional foregroundServiceType parameter.

Apps built with SDK version Build.VERSION_CODES.Q or later can specify the foreground service types using attribute R.attr.foregroundServiceType in service element of manifest file. The value of attribute R.attr.foregroundServiceType can be multiple flags ORed together.

The foregroundServiceType parameter must be a subset flags of what is specified in manifest attribute R.attr.foregroundServiceType, if not, an IllegalArgumentException is thrown. Specify foregroundServiceType parameter as ServiceInfo.FOREGROUND_SERVICE_TYPE_MANIFEST to use all flags that is specified in manifest attribute foregroundServiceType.

• ServiceInfo.FOREGROUND_SERVICE_TYPE_MANIFEST
• ServiceInfo.FOREGROUND_SERVICE_TYPE_NONE
• ServiceInfo.FOREGROUND_SERVICE_TYPE_DATA_SYNC
• ServiceInfo.FOREGROUND_SERVICE_TYPE_MEDIA_PLAYBACK
• ServiceInfo.FOREGROUND_SERVICE_TYPE_PHONE_CALL
• ServiceInfo.FOREGROUND_SERVICE_TYPE_LOCATION
• ServiceInfo.FOREGROUND_SERVICE_TYPE_CONNECTED_DEVICE
• ServiceInfo.FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION
• ServiceInfo.FOREGROUND_SERVICE_TYPE_CAMERA
• ServiceInfo.FOREGROUND_SERVICE_TYPE_MICROPHONE
• ServiceInfo.FOREGROUND_SERVICE_TYPE_HEALTH
• ServiceInfo.FOREGROUND_SERVICE_TYPE_REMOTE_MESSAGING
• ServiceInfo.FOREGROUND_SERVICE_TYPE_SYSTEM_EXEMPTED
• ServiceInfo.FOREGROUND_SERVICE_TYPE_SHORT_SERVICE
• ServiceInfo.FOREGROUND_SERVICE_TYPE_MEDIA_PROCESSING
• ServiceInfo.FOREGROUND_SERVICE_TYPE_SPECIAL_USE

stopForeground

public final void stopForeground (int notificationBehavior)

Remove this service from foreground state, allowing it to be killed if more memory is needed. This does not stop the service from running (for that you use stopSelf() or related methods), just takes it out of the foreground state.

If STOP_FOREGROUND_REMOVE is supplied, the service's associated notification will be cancelled immediately.

If STOP_FOREGROUND_DETACH is supplied, the service's association with the notification will be severed. If the notification had not yet been shown, due to foreground-service notification deferral policy, it is immediately posted when stopForeground(STOP_FOREGROUND_DETACH) is called. In all cases, the notification remains shown even after this service is stopped fully and destroyed.

If zero is passed as the argument, the result will be the legacy behavior as defined prior to Android L: the notification will remain posted until the service is fully stopped, at which time it will automatically be cancelled.

• STOP_FOREGROUND_LEGACY
• STOP_FOREGROUND_REMOVE
• STOP_FOREGROUND_DETACH

public final void stopForeground (boolean removeNotification)

public final void stopSelf ()

public final void stopSelf (int startId)

public final boolean stopSelfResult (int startId)

Protected methods

protected void attachBaseContext (Context newBase)

protected void dump (FileDescriptor fd, 
                PrintWriter writer, 
                String[] args)