Os tipos de serviço em primeiro plano são obrigatórios

Para ajudar os desenvolvedores na definição de serviços em primeiro plano voltados ao usuário, o Android 10 introduziu o atributo android:foregroundServiceType no elemento <service>.

Caso o app seja destinado ao Android 14, é necessário especificar os tipos de serviço em primeiro plano adequados. Como nas versões anteriores do Android, vários tipos podem ser combinados. Esta lista mostra os tipos de serviço em primeiro plano que você pode escolher:

Se um caso de uso no app não estiver associado a nenhum desses tipos, é recomendável migrar a lógica para usar o WorkManager ou jobs de transferência de dados iniciados pelo usuário.

Os tipos health, remoteMessaging, shortService, specialUse e systemExempted são novos no Android 14.

O snippet de código abaixo mostra um exemplo de declaração de tipo de serviço em primeiro plano no manifesto:

<manifest ...>
  <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
  <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK" />
    <application ...>
      <service
          android:name=".MyMediaPlaybackService"
          android:foregroundServiceType="mediaPlayback"
          android:exported="false">
      </service>
    </application>
</manifest>

Se um app destinado ao Android 14 não definir tipos para um determinado serviço no manifesto, o sistema vai gerar uma MissingForegroundServiceTypeException ao chamar startForeground() para o serviço.

Declarar nova permissão para usar tipos de serviço em primeiro plano

If apps that target Android 14 use a foreground service, they must declare a specific permission, based on the foreground service type, that Android 14 introduces. These permissions appear in the sections labeled "permission that you must declare in your manifest file" in the intended use cases and enforcement for each foreground service type section on this page.

All of the permissions are defined as normal permissions and are granted by default. Users cannot revoke these permissions.

Incluir tipo de serviço em primeiro plano no momento da execução

The best practice for applications starting foreground services is to use the ServiceCompat version of startForeground() (available in androidx-core 1.12 and higher) where you pass in a bitwise integer of foreground service types. You can choose to pass one or more type values.

Usually, you should declare only the types required for a particular use case. This makes it easier to meet the system's expectations for each foreground service type. In cases where a foreground service is started with multiple types, then the foreground service must adhere to the platform enforcement requirements of all types.

ServiceCompat.startForeground(0, notification, FOREGROUND_SERVICE_TYPE_LOCATION)

If the foreground service type is not specified in the call, the type defaults to the values defined in the manifest. If you didn't specify the service type in the manifest, the system throws MissingForegroundServiceTypeException.

If the foreground service needs new permissions after you launch it, you should call startForeground() again and add the new service types. For example, suppose a fitness app runs a running-tracker service that always needs location information, but might or might not need media permissions. You would need to declare both location and mediaPlayback in the manifest. If a user starts a run and just wants their location tracked, your app should call startForeground() and pass just the location service type. Then, if the user wants to start playing audio, call startForeground() again and pass location|mediaPlayback.

Verificações do momento de execução no sistema

The system checks for proper use of foreground service types and confirms that the app has requested the proper runtime permissions or uses the required APIs. For instance, the system expects apps that use the foreground service type FOREGROUND_SERVICE_TYPE_LOCATION type to request either ACCESS_COARSE_LOCATION or ACCESS_FINE_LOCATION.

This implies that apps must follow a very specific order of operations when requesting permissions from the user and starting foreground services. Permissions must be requested and granted before the app attempts to call startForeground(). Apps that request the appropriate permissions after the foreground service has been started must change this order of operations and request the permission before starting the foreground service.

The specifics of platform enforcement appear in the sections labeled "runtime requirements" in the intended use cases and enforcement for each foreground service type section on this page.

Casos de uso pretendidos e aplicação de cada tipo de serviço em primeiro plano

In order to use a given foreground service type, you must declare a particular permission in your manifest file, you must fulfill specific runtime requirements, and your app must fulfill one of the intended sets of use cases for that type. The following sections explain the permission that you must declare, the runtime prerequisites, and the intended use cases for each type.

Câmera

Tipo de serviço em primeiro plano a ser declarado no manifesto em android:foregroundServiceType
camera
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_CAMERA
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_CAMERA
Pré-requisitos do ambiente de execução

Solicitar e receber a permissão de execução CAMERA

Observação:a permissão de execução CAMERA está sujeita a restrições durante o uso. Por esse motivo, não é possível criar um serviço em primeiro plano camera enquanto o app está em segundo plano, com algumas exceções. Para mais informações, consulte Restrições para iniciar serviços em primeiro plano que precisam de permissões em uso.

Descrição

Continue acessando a câmera em segundo plano, como em apps de chat por vídeo que permitem várias tarefas.

Dispositivo conectado

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
connectedDevice
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_CONNECTED_DEVICE
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_CONNECTED_DEVICE
Pré-requisitos do ambiente de execução

Pelo menos uma das condições a seguir precisa ser verdadeira:

Descrição

Interações com dispositivos externos que exigem uma conexão Bluetooth, NFC, IR, USB ou de rede.

Alternativas

Se o app precisar fazer transferências de dados contínuas para um dispositivo externo, use o gerenciador de dispositivo complementar. Use a API de presença de dispositivo complementar para ajudar o app a continuar em execução enquanto o dispositivo complementar está no alcance.

Se o app precisar procurar dispositivos Bluetooth, use a API de verificação de Bluetooth.

Sincronização de dados

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
dataSync
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_DATA_SYNC
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_DATA_SYNC
Pré-requisitos do ambiente de execução
Nenhum
Descrição

Operações de transferência de dados, como as seguintes:

  • Upload ou download de dados
  • Operações de backup e restauração
  • Operações de importação ou exportação
  • Busca de dados
  • Processamento local de arquivos
  • Transferência de dados entre um dispositivo e a nuvem por uma rede
Alternativas

Consulte Alternativas aos serviços em primeiro plano de sincronização de dados para informações detalhadas.

Saúde

Foreground service type to declare in manifest under
android:foregroundServiceType
health
Permission to declare in your manifest
FOREGROUND_SERVICE_HEALTH
Constant to pass to startForeground()
FOREGROUND_SERVICE_TYPE_HEALTH
Runtime prerequisites

At least one of the following conditions must be true:

Note: The BODY_SENSORS and sensor-based READ runtime permissions are subject to while-in-use restrictions. For this reason, you cannot create a health foreground service that uses body sensors while your app is in the background unless you've been granted the BODY_SENSORS_BACKGROUND (API level 33 to 35) or READ_HEALTH_DATA_IN_BACKGROUND (API level 36 and higher) permissions. For more information, see Restrictions on starting foreground services that need while-in-use permissions.

Description

Any long-running use cases to support apps in the fitness category such as exercise trackers.

Local

Foreground service type to declare in manifest under
android:foregroundServiceType
location
Permission to declare in your manifest
FOREGROUND_SERVICE_LOCATION
Constant to pass to startForeground()
FOREGROUND_SERVICE_TYPE_LOCATION
Runtime prerequisites

The user must have enabled location services and the app must be granted at least one of the following runtime permissions:

Note: In order to check that the user has enabled location services as well as granted access to the runtime permissions, use PermissionChecker#checkSelfPermission()

Note: The location runtime permissions are subject to while-in-use restrictions. For this reason, you cannot create a location foreground service while your app is in the background, unless you've been granted the ACCESS_BACKGROUND_LOCATION runtime permission. For more information, see Restrictions on starting foreground services that need while-in-use permissions.

Description

Long-running use cases that require location access, such as navigation and location sharing.

Alternatives

If your app needs to be triggered when the user reaches specific locations, consider using the geofence API instead.

Mídia

Foreground service type to declare in manifest under
android:foregroundServiceType
mediaPlayback
Permission to declare in your manifest
FOREGROUND_SERVICE_MEDIA_PLAYBACK
Constant to pass to startForeground()
FOREGROUND_SERVICE_TYPE_MEDIA_PLAYBACK
Runtime prerequisites
None
Description
Continue audio or video playback from the background. Support Digital Video Recording (DVR) functionality on Android TV.
Alternatives
If you're showing picture-in-picture video, use Picture-in-Picture mode.

Projeção de mídia

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
mediaProjection
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_MEDIA_PROJECTION
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION
Pré-requisitos do ambiente de execução

Chame o método createScreenCaptureIntent() antes de iniciar o serviço em primeiro plano. Isso mostra uma notificação de permissão ao usuário. Ele precisa conceder a permissão antes que você possa criar o serviço.

Depois de criar o serviço em primeiro plano, você pode chamar MediaProjectionManager.getMediaProjection().

Descrição

Projete conteúdo em uma tela secundária ou um dispositivo externo usando as APIs MediaProjection. Esse conteúdo não precisa ser exclusivamente de mídia.

Alternativas

Para transmitir mídia para outro dispositivo, use o SDK do Google Cast.

Microfone

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
microphone
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_MICROPHONE
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_MICROPHONE
Pré-requisitos do ambiente de execução

Solicite e receba a permissão de execução RECORD_AUDIO.

Observação:a permissão de execução RECORD_AUDIO está sujeita a restrições durante o uso. Por esse motivo, não é possível criar um serviço em primeiro plano microphone enquanto o app está em segundo plano, com algumas exceções. Para mais informações, consulte Restrições para iniciar serviços em primeiro plano que precisam de permissões em uso.

Descrição

Continue a captura do microfone em segundo plano, como gravadores de voz ou apps de comunicação.

Ligação telefônica

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
phoneCall
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_PHONE_CALL
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_PHONE_CALL
Pré-requisitos do ambiente de execução

Pelo menos uma destas condições precisa ser verdadeira:

Descrição

Continue uma chamada usando as APIs ConnectionService.

Alternativas

Se você precisar fazer ligações telefônicas, de vídeo ou VoIP, use a biblioteca android.telecom.

Considere usar CallScreeningService para filtrar ligações.

Mensagens remotas

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
remoteMessaging
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_REMOTE_MESSAGING
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_REMOTE_MESSAGING
Pré-requisitos do ambiente de execução
Nenhum
Descrição
Transferir mensagens de texto de um dispositivo para outro. Ajuda na continuidade das tarefas de mensagens de um usuário ao trocar de dispositivo.

Serviço curto

Foreground service type to declare in manifest under
android:foregroundServiceType
shortService
Permission to declare in your manifest
None
Constant to pass to startForeground()
FOREGROUND_SERVICE_TYPE_SHORT_SERVICE
Runtime prerequisites
None
Description

Quickly finish critical work that cannot be interrupted or postponed.

This type has some unique characteristics:

  • Can only run for a short period of time (about 3 minutes).
  • No support for sticky foreground services.
  • Cannot start other foreground services.
  • Doesn't require a type-specific permission, though it still requires the FOREGROUND_SERVICE permission.
  • A shortService can only change to another service type if the app is currently eligible to start a new foreground service.
  • A foreground service can change its type to shortService at any time, at which point the timeout period begins.

The timeout for shortService begins from the moment that Service.startForeground() is called. The app is expected to call Service.stopSelf() or Service.stopForeground() before the timeout occurs. Otherwise, the new Service.onTimeout() is called, giving apps a brief opportunity to call stopSelf() or stopForeground() to stop their service.

A short time after Service.onTimeout() is called, the app enters a cached state and is no longer considered to be in the foreground, unless the user is actively interacting with the app. A short time after the app is cached and the service has not stopped, the app receives an ANR. The ANR message mentions FOREGROUND_SERVICE_TYPE_SHORT_SERVICE. For these reasons, it's considered best practice to implement the Service.onTimeout() callback.

The Service.onTimeout() callback doesn't exist on Android 13 and lower. If the same service runs on such devices, it doesn't receive a timeout, nor does it ANR. Make sure that your service stops as soon as it finishes the processing task, even if it hasn't received the Service.onTimeout() callback yet.

It's important to note that if the timeout of the shortService is not respected, the app will ANR even if it has other valid foreground services or other app lifecycle processes running.

If an app is visible to the user or satisfies one of the exemptions that allow foreground services to be started from the background, calling Service.StartForeground() again with the FOREGROUND_SERVICE_TYPE_SHORT_SERVICE parameter extends the timeout by another 3 minutes. If the app isn't visible to the user and doesn't satisfy one of the exemptions, any attempt to start another foreground service, regardless of type, causes a ForegroundServiceStartNotAllowedException.

If a user disables battery optimization for your app, it's still affected by the timeout of shortService FGS.

If you start a foreground service that includes the shortService type and another foreground service type, the system ignores the shortService type declaration. However, the service must still adhere to the prerequisites of the other declared types. For more information, see the Foreground services documentation.

Uso especial

Foreground service type to declare in manifest under
android:foregroundServiceType
specialUse
Permission to declare in your manifest
FOREGROUND_SERVICE_SPECIAL_USE
Constant to pass to startForeground()
FOREGROUND_SERVICE_TYPE_SPECIAL_USE
Runtime prerequisites
None
Description

Covers any valid foreground service use cases that aren't covered by the other foreground service types.

In addition to declaring the FOREGROUND_SERVICE_TYPE_SPECIAL_USE foreground service type, developers should declare use cases in the manifest. To do so, they specify the <property> element within the <service> element. These values and corresponding use cases are reviewed when you submit your app in the Google Play Console. The use cases you provide are free-form, and you should make sure to provide enough information to let the reviewer see why you need to use the specialUse type.

<service android:name="fooService" android:foregroundServiceType="specialUse">
  <property android:name="android.app.PROPERTY_SPECIAL_USE_FGS_SUBTYPE"
      android:value="explanation_for_special_use"/>
</service>

Sistema isento

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
systemExempted
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_SYSTEM_EXEMPTED
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_SYSTEM_EXEMPTED
Pré-requisitos do ambiente de execução
Nenhum
Descrição

Reservado para que aplicativos do sistema e integrações específicas do sistema possam continuar a usar serviços em primeiro plano.

Para usar esse tipo, um app precisa atender a pelo menos um destes critérios:

Aplicação da política do Google Play para uso de tipos de serviço em primeiro plano

Se o app for direcionado ao Android 14 ou versões mais recentes, será necessário declarar os tipos de serviço em primeiro plano na página "Conteúdo do app" do Play Console (Política > Conteúdo do app). Para mais informações sobre como declarar seus tipos de serviço em primeiro plano no Play Console, consulte Saiba mais sobre o serviço em primeiro plano e os requisitos de intent para tela cheia.