Most visited

Recently visited

Results for

ServiceInfo

public class ServiceInfo
extends ComponentInfo implements Parcelable

java.lang.Object
↳	android.content.pm.PackageItemInfo
	↳	android.content.pm.ComponentInfo
		↳	android.content.pm.ServiceInfo

Information you can retrieve about a particular application service. This corresponds to information collected from the AndroidManifest.xml's <service> tags.

Summary

Constants
`int`	`FLAG_EXTERNAL_SERVICE` Bit in `flags`: If set, the service can be bound and run in the calling application's package, rather than the package in which it is declared.
`int`	`FLAG_ISOLATED_PROCESS` Bit in `flags`: If set, the service will run in its own isolated process.
`int`	`FLAG_SINGLE_USER` Bit in `flags`: If set, a single instance of the service will run for all users on the device.
`int`	`FLAG_STOP_WITH_TASK` Bit in `flags`: If set, the service will automatically be stopped by the system if the user removes a task that is rooted in one of the application's activities.
`int`	`FLAG_USE_APP_ZYGOTE` Bit in `flags`: If set, the service (which must be isolated) will be spawned from an Application Zygote, instead of the regular Zygote.
`int`	`FOREGROUND_SERVICE_TYPE_CAMERA` Constant corresponding to `camera` in the `R.attr.foregroundServiceType` attribute.
`int`	`FOREGROUND_SERVICE_TYPE_CONNECTED_DEVICE` Constant corresponding to `connectedDevice` in the `R.attr.foregroundServiceType` attribute.
`int`	`FOREGROUND_SERVICE_TYPE_DATA_SYNC` Constant corresponding to `dataSync` in the `R.attr.foregroundServiceType` attribute.
`int`	`FOREGROUND_SERVICE_TYPE_LOCATION` Constant corresponding to `location` in the `R.attr.foregroundServiceType` attribute.
`int`	`FOREGROUND_SERVICE_TYPE_MANIFEST` A special value indicates to use all types set in manifest file.
`int`	`FOREGROUND_SERVICE_TYPE_MEDIA_PLAYBACK` Constant corresponding to `mediaPlayback` in the `R.attr.foregroundServiceType` attribute.
`int`	`FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION` Constant corresponding to `mediaProjection` in the `R.attr.foregroundServiceType` attribute.
`int`	`FOREGROUND_SERVICE_TYPE_MICROPHONE` Constant corresponding to `microphone` in the `R.attr.foregroundServiceType` attribute.
`int`	`FOREGROUND_SERVICE_TYPE_NONE` The default foreground service type if not been set in manifest file.
`int`	`FOREGROUND_SERVICE_TYPE_PHONE_CALL` Constant corresponding to `phoneCall` in the `R.attr.foregroundServiceType` attribute.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<ServiceInfo>`	`CREATOR`
`public int`	`flags` Options that have been set in the service declaration in the manifest.
`public String`	`permission` Optional name of a permission required to be able to access this Service.

Inherited fields

From class android.content.pm.ComponentInfo

`public ApplicationInfo`	`applicationInfo` Global information about the application/package this component is a part of.
`public int`	`descriptionRes` A string resource identifier (in the package's resources) containing a user-readable description of the component.
`public boolean`	`directBootAware` Indicates if this component is aware of direct boot lifecycle, and can be safely run before the user has entered their credentials (such as a lock pattern or PIN).
`public boolean`	`enabled` Indicates whether or not this component may be instantiated.
`public boolean`	`exported` Set to true if this component is available for use by other applications.
`public String`	`processName` The name of the process this component should run in.
`public String`	`splitName` The name of the split in which this component is declared.

From class android.content.pm.PackageItemInfo

`public int`	`banner` A drawable resource identifier (in the package's resources) of this component's banner.
`public int`	`icon` A drawable resource identifier (in the package's resources) of this component's icon.
`public int`	`labelRes` A string resource identifier (in the package's resources) of this component's label.
`public int`	`logo` A drawable resource identifier (in the package's resources) of this component's logo.
`public Bundle`	`metaData` Additional meta-data associated with this component.
`public String`	`name` Public name of this item.
`public CharSequence`	`nonLocalizedLabel` The string provided in the AndroidManifest file, if any.
`public String`	`packageName` Name of the package that this item is in.

Public constructors
`ServiceInfo()`
`ServiceInfo(ServiceInfo orig)`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`void`	`dump(Printer pw, String prefix)`
`int`	`getForegroundServiceType()` Return foreground service type specified in the manifest..
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int parcelableFlags)`

Inherited methods

From class


        
          android.content.pm.ComponentInfo

`void`	`dumpBack(Printer pw, String prefix)`
`void`	`dumpFront(Printer pw, String prefix)`
`final int`	`getBannerResource()` Return the banner resource identifier to use for this component.
`final int`	`getIconResource()` Return the icon resource identifier to use for this component.
`final int`	`getLogoResource()` Return the logo resource identifier to use for this component.
`boolean`	`isEnabled()` Return whether this component and its enclosing application are enabled.
`void`	`writeToParcel(Parcel dest, int parcelableFlags)`

From class


        
          android.content.pm.PackageItemInfo

`void`	`dumpBack(Printer pw, String prefix)`
`void`	`dumpFront(Printer pw, String prefix)`
`Drawable`	`loadBanner(PackageManager pm)` Retrieve the current graphical banner associated with this item.
`Drawable`	`loadIcon(PackageManager pm)` Retrieve the current graphical icon associated with this item.
`CharSequence`	`loadLabel(PackageManager pm)` Retrieve the current textual label associated with this item.
`Drawable`	`loadLogo(PackageManager pm)` Retrieve the current graphical logo associated with this item.
`Drawable`	`loadUnbadgedIcon(PackageManager pm)` Retrieve the current graphical icon associated with this item without the addition of a work badge if applicable.
`XmlResourceParser`	`loadXmlMetaData(PackageManager pm, String name)` Load an XML resource attached to the meta-data of this item.
`void`	`writeToParcel(Parcel dest, int parcelableFlags)`

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

FLAG_EXTERNAL_SERVICE

public static final int FLAG_EXTERNAL_SERVICE

Bit in flags: If set, the service can be bound and run in the calling application's package, rather than the package in which it is declared. Set from R.attr.externalService attribute.

Constant Value: 4 (0x00000004)

FLAG_ISOLATED_PROCESS

public static final int FLAG_ISOLATED_PROCESS

Bit in flags: If set, the service will run in its own isolated process. Set from the R.attr.isolatedProcess attribute.

Constant Value: 2 (0x00000002)

FLAG_SINGLE_USER

public static final int FLAG_SINGLE_USER

Bit in flags: If set, a single instance of the service will run for all users on the device. Set from the R.attr.singleUser attribute.

Constant Value: 1073741824 (0x40000000)

FLAG_STOP_WITH_TASK

public static final int FLAG_STOP_WITH_TASK

Bit in flags: If set, the service will automatically be stopped by the system if the user removes a task that is rooted in one of the application's activities. Set from the R.attr.stopWithTask attribute.

Constant Value: 1 (0x00000001)

FLAG_USE_APP_ZYGOTE

public static final int FLAG_USE_APP_ZYGOTE

Bit in flags: If set, the service (which must be isolated) will be spawned from an Application Zygote, instead of the regular Zygote. The Application Zygote will pre-initialize the application's class loader, and call a static callback into the application to allow it to perform application-specific preloads (such as loading a shared library). Therefore, spawning from the Application Zygote will typically reduce the service launch time and reduce its memory usage. The downside of using this flag is that you will have an additional process (the app zygote itself) that is taking up memory. Whether actual memory usage is improved therefore strongly depends on the number of isolated services that an application starts, and how much memory those services save by preloading. Therefore, it is recommended to measure memory usage under typical workloads to determine whether it makes sense to use this flag.

Constant Value: 8 (0x00000008)

FOREGROUND_SERVICE_TYPE_CAMERA

public static final int FOREGROUND_SERVICE_TYPE_CAMERA

Constant corresponding to camera in the R.attr.foregroundServiceType attribute. Use the camera device or record video. For apps with targetSdkVersion Build.VERSION_CODES.R and above, a foreground service will not be able to access the camera if this type is not specified in the manifest and in Service.startForeground(int, android.app.Notification, int).

Constant Value: 64 (0x00000040)

FOREGROUND_SERVICE_TYPE_CONNECTED_DEVICE

public static final int FOREGROUND_SERVICE_TYPE_CONNECTED_DEVICE

Constant corresponding to connectedDevice in the R.attr.foregroundServiceType attribute. Auto, bluetooth, TV or other devices connection, monitoring and interaction.

Constant Value: 16 (0x00000010)

FOREGROUND_SERVICE_TYPE_DATA_SYNC

public static final int FOREGROUND_SERVICE_TYPE_DATA_SYNC

Constant corresponding to dataSync in the R.attr.foregroundServiceType attribute. Data(photo, file, account) upload/download, backup/restore, import/export, fetch, transfer over network between device and cloud.

Constant Value: 1 (0x00000001)

FOREGROUND_SERVICE_TYPE_LOCATION

public static final int FOREGROUND_SERVICE_TYPE_LOCATION

Constant corresponding to location in the R.attr.foregroundServiceType attribute. GPS, map, navigation location update.

Constant Value: 8 (0x00000008)

FOREGROUND_SERVICE_TYPE_MANIFEST

public static final int FOREGROUND_SERVICE_TYPE_MANIFEST

A special value indicates to use all types set in manifest file.

Constant Value: -1 (0xffffffff)

FOREGROUND_SERVICE_TYPE_MEDIA_PLAYBACK

public static final int FOREGROUND_SERVICE_TYPE_MEDIA_PLAYBACK

Constant corresponding to mediaPlayback in the R.attr.foregroundServiceType attribute. Music, video, news or other media playback.

Constant Value: 2 (0x00000002)

FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION

public static final int FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION

Constant corresponding to mediaProjection in the R.attr.foregroundServiceType attribute. Managing a media projection session, e.g for screen recording or taking screenshots.

Constant Value: 32 (0x00000020)

FOREGROUND_SERVICE_TYPE_MICROPHONE

public static final int FOREGROUND_SERVICE_TYPE_MICROPHONE

Constant corresponding to microphone in the R.attr.foregroundServiceType attribute. Use the microphone device or record audio. For apps with targetSdkVersion Build.VERSION_CODES.R and above, a foreground service will not be able to access the microphone if this type is not specified in the manifest and in Service.startForeground(int, android.app.Notification, int).

Constant Value: 128 (0x00000080)

FOREGROUND_SERVICE_TYPE_NONE

public static final int FOREGROUND_SERVICE_TYPE_NONE

The default foreground service type if not been set in manifest file.

Constant Value: 0 (0x00000000)

FOREGROUND_SERVICE_TYPE_PHONE_CALL

public static final int FOREGROUND_SERVICE_TYPE_PHONE_CALL

Constant corresponding to phoneCall in the R.attr.foregroundServiceType attribute. Ongoing phone call or video conference.

Constant Value: 4 (0x00000004)

Fields

CREATOR

public static final Creator<ServiceInfo> CREATOR

flags

public int flags

Options that have been set in the service declaration in the manifest. These include: FLAG_STOP_WITH_TASK, FLAG_ISOLATED_PROCESS, FLAG_SINGLE_USER.

permission

public String permission

Optional name of a permission required to be able to access this Service. From the "permission" attribute.

Public constructors

ServiceInfo

public ServiceInfo ()

ServiceInfo

public ServiceInfo (ServiceInfo orig)

Parameters
`orig`	`ServiceInfo`

Public methods

describeContents

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

dump

public void dump (Printer pw, 
                String prefix)

Parameters
`pw`	`Printer`
`prefix`	`String`

getForegroundServiceType

public int getForegroundServiceType ()

Return foreground service type specified in the manifest..

Returns

Returns
`int`	foreground service type specified in the manifest. Value is either `0` or a combination of `FOREGROUND_SERVICE_TYPE_MANIFEST`, `FOREGROUND_SERVICE_TYPE_NONE`, `FOREGROUND_SERVICE_TYPE_DATA_SYNC`, `FOREGROUND_SERVICE_TYPE_MEDIA_PLAYBACK`, `FOREGROUND_SERVICE_TYPE_PHONE_CALL`, `FOREGROUND_SERVICE_TYPE_LOCATION`, `FOREGROUND_SERVICE_TYPE_CONNECTED_DEVICE`, `FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION`, `FOREGROUND_SERVICE_TYPE_CAMERA`, and `FOREGROUND_SERVICE_TYPE_MICROPHONE`

int

foreground service type specified in the manifest. Value is either 0 or a combination of FOREGROUND_SERVICE_TYPE_MANIFEST, FOREGROUND_SERVICE_TYPE_NONE, FOREGROUND_SERVICE_TYPE_DATA_SYNC, FOREGROUND_SERVICE_TYPE_MEDIA_PLAYBACK, FOREGROUND_SERVICE_TYPE_PHONE_CALL, FOREGROUND_SERVICE_TYPE_LOCATION, FOREGROUND_SERVICE_TYPE_CONNECTED_DEVICE, FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION, FOREGROUND_SERVICE_TYPE_CAMERA, and FOREGROUND_SERVICE_TYPE_MICROPHONE

toString

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
`String`	a string representation of the object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int parcelableFlags)

Parameters
`dest`	`Parcel`
`parcelableFlags`	`int`