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

Se os apps direcionados ao Android 14 usarem um serviço em primeiro plano, eles precisarão declarar uma permissão específica, com base no tipo de serviço em primeiro plano, que foi introduzida no Android 14. Essas permissões são exibidas nas seções denominadas "permissão que você precisa declarar no arquivo de manifesto" na seção de casos de uso pretendidos e aplicação de cada tipo de serviço em primeiro plano nesta página.

Todas as permissões são definidas como permissões normais e são concedidas por padrão. Os usuários não podem revogar essas permissões.

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

A prática recomendada para aplicativos que iniciam serviços em primeiro plano é usar o Versão ServiceCompat do startForeground() (disponível no androidx-core) 1.12 e superior) em que você transmite a bit a bit a bit Número inteiro dos tipos de serviço em primeiro plano. É possível transmitir um ou mais valores de tipo.

Normalmente, você precisa declarar apenas os tipos necessários para um caso de uso específico. Isso facilita o cumprimento das expectativas do sistema para cada primeiro plano tipo de serviço. Nos casos em que um serviço em primeiro plano é iniciado com vários tipos, o serviço em primeiro plano precisa aderir às aplicações da plataforma requisitos de todos os tipos.

ServiceCompat.startForeground(0, notification, FOREGROUND_SERVICE_TYPE_LOCATION)

Se o tipo de serviço em primeiro plano não for especificado na chamada, o padrão será os valores definidos no manifesto. Se você não especificou o serviço no manifesto, o sistema gera MissingForegroundServiceTypeException

Se o serviço em primeiro plano precisar de novas permissões depois de iniciá-lo, precisa chamar startForeground() novamente e adicionar os novos tipos de serviço. Para exemplo, suponha que um aplicativo de condicionamento físico execute um serviço de acompanhamento de corrida que sempre precisa location, mas pode ou não precisar das permissões media. Você seria necessário declarar location e mediaPlayback no manifesto. Se um usuário iniciar uma corrida e quiser apenas rastrear a localização, seu app precisará chamar startForeground() e transmitir apenas o tipo de serviço location. Então, se o usuário quer começar a tocar áudio, chame startForeground() novamente e transmita location|mediaPlayback.

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

O sistema confere o uso adequado dos tipos de serviço em primeiro plano e confirma se o app solicitou as permissões de execução adequadas ou se ele usa as APIs necessárias. Por exemplo, o sistema espera que apps que usam o tipo de serviço em primeiro plano FOREGROUND_SERVICE_TYPE_LOCATION solicitem ACCESS_COARSE_LOCATION ou ACCESS_FINE_LOCATION.

Isso significa que os apps precisam seguir uma ordem muito específica de operações ao solicitar permissões do usuário e iniciar serviços em primeiro plano. As permissões precisam ser solicitadas e concedidas antes que o app tente chamar startForeground(). Os apps que solicitam as permissões adequadas após a inicialização do serviço em primeiro plano precisam mudar essa ordem de operações e solicitar a permissão antes de iniciar o serviço.

As especificidades da aplicação da plataforma aparecem nas seções denominadas "requisitos de tempo de execução" na seção de casos de uso pretendidos e aplicação para cada tipo de serviço em primeiro plano nesta página.

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

Para usar determinado tipo de serviço em primeiro plano, é necessário declarar uma permissão específica no arquivo de manifesto e atender a requisitos de execução específicos. Além disso, seu app precisa atender a um dos conjuntos de casos de uso pretendidos para esse tipo. As seções a seguir explicam a permissão que você precisa declarar, os pré-requisitos de execução e os casos de uso pretendidos para cada tipo.

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 a ser transmitida para startForeground()
FOREGROUND_SERVICE_TYPE_CAMERA
Pré-requisitos de tempo 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 durante o 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
android:foregroundServiceType
connectedDevice
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_CONNECTED_DEVICE
Constante a ser transmitida para startForeground()
FOREGROUND_SERVICE_TYPE_CONNECTED_DEVICE
Pré-requisitos de tempo 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 uma transferência contínua de dados para um dispositivo externo, use o gerenciador de dispositivos complementar. Use a API de presença de dispositivo complementar para ajudar o app a continuar em execução enquanto o dispositivo complementar estiver ao alcance.

Se o app precisar procurar dispositivos Bluetooth, use a API Bluetooth Scan.

Sincronização de dados

Tipo de serviço em primeiro plano a ser declarado no manifesto
android:foregroundServiceType
dataSync
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_DATA_SYNC
Constante a ser transmitida para startForeground()
FOREGROUND_SERVICE_TYPE_DATA_SYNC
Pré-requisitos de tempo 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 à sincronização de dados para serviços em primeiro plano para informações detalhadas.

Saúde

Tipo de serviço em primeiro plano a ser declarado no manifesto
android:foregroundServiceType
health
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_HEALTH
Constante a ser transmitida para startForeground()
FOREGROUND_SERVICE_TYPE_HEALTH
Pré-requisitos de tempo de execução

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

Observação:a permissão de execução BODY_SENSORS está sujeita a restrições durante o uso. Por esse motivo, não é possível criar um serviço em primeiro plano health que use sensores corporais enquanto o app estiver 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 durante o uso.

Descrição

Todos os casos de uso de longa duração que oferecem suporte a apps na categoria fitness, como apps de monitoramento de atividade física.

Local

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
location
Permissão para declarar no manifesto
FOREGROUND_SERVICE_LOCATION
Constante a ser transmitida para startForeground()
FOREGROUND_SERVICE_TYPE_LOCATION
Pré-requisitos do ambiente de execução

O usuário precisa ter ativado os Serviços de localização, e o app precisa receber pelo menos uma das seguintes permissões de execução:

Observação:para verificar se o usuário ativou os serviços de localização e concedeu acesso às permissões de execução, use PermissionChecker#checkSelfPermission().

Observação:as permissões de execução de local estão sujeitas a restrições durante o uso. Por esse motivo, não é possível criar um serviço em primeiro plano location enquanto o app está em segundo plano, a menos que você tenha recebido a permissão de execução ACCESS_BACKGROUND_LOCATION. Para mais informações, consulte Restrições para iniciar serviços em primeiro plano que precisam de permissões durante o uso.

Descrição

Casos de uso de longa duração que exigem acesso à localização, como navegação e compartilhamento de local.

Alternativas

Se o app precisar ser acionado quando o usuário chegar a locais específicos, considere usar a API Geoofence.

Mídia

Tipo de serviço em primeiro plano a ser declarado no manifesto
android:foregroundServiceType
mediaPlayback
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_MEDIA_PLAYBACK
Constante a ser transmitida para startForeground()
FOREGROUND_SERVICE_TYPE_MEDIA_PLAYBACK
Pré-requisitos de tempo de execução
Nenhum
Descrição
Continue reproduzindo áudio ou vídeo em segundo plano. Suporte à funcionalidade de gravação de vídeo digital (DVR) no Android TV.
Alternativas
Se você estiver exibindo vídeos picture-in-picture, use o modo picture-in-picture.

Projeção de mídia

Tipo de serviço em primeiro plano a ser declarado no manifesto
android:foregroundServiceType
mediaProjection
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_MEDIA_PROJECTION
Constante a ser transmitida para startForeground()
FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION
Pré-requisitos de tempo 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, que precisa concedê-la antes de você criar o serviço.

Depois de criar o serviço em primeiro plano, chame MediaProjectionManager.getMediaProjection().

Descrição

Projete o 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 fazer streaming de mídia em outro dispositivo, use o SDK do Google Cast.

Microfone

Tipo de serviço em primeiro plano a ser declarado no manifesto
android:foregroundServiceType
microphone
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_MICROPHONE
Constante a ser transmitida para startForeground()
FOREGROUND_SERVICE_TYPE_MICROPHONE
Pré-requisitos de tempo 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 durante o 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
android:foregroundServiceType
phoneCall
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_PHONE_CALL
Constante a ser transmitida para startForeground()
FOREGROUND_SERVICE_TYPE_PHONE_CALL
Pré-requisitos de tempo de execução

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

  • Esse é o app de discador padrão com o papel ROLE_DIALER.
Descrição

Continue uma chamada usando as APIs ConnectionService.

Alternativas

Se você precisar fazer chamadas telefônicas, de vídeo ou VoIP, considere usar a biblioteca android.telecom.

Use o CallScreeningService para filtrar ligações.

Mensagens remotas

Tipo de serviço em primeiro plano a ser declarado no manifesto
android:foregroundServiceType
remoteMessaging
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_REMOTE_MESSAGING
Constante a ser transmitida para startForeground()
FOREGROUND_SERVICE_TYPE_REMOTE_MESSAGING
Pré-requisitos de tempo 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

Tipo de serviço em primeiro plano a ser declarado no manifesto
android:foregroundServiceType
shortService
Permissão a ser declarada no manifesto
Nenhum
Constante a ser transmitida para startForeground()
FOREGROUND_SERVICE_TYPE_SHORT_SERVICE
Pré-requisitos de tempo de execução
Nenhum
Descrição

Conclua rapidamente trabalhos essenciais que não podem ser interrompidos ou adiados.

Esse tipo tem algumas características únicas:

  • Pode ser executado por um curto período de tempo (cerca de três minutos).
  • Não oferece suporte a serviços fixos em primeiro plano.
  • Não inicia outros serviços em primeiro plano.
  • Não requer uma permissão específica do tipo, embora ainda exija a permissão FOREGROUND_SERVICE.
  • Um shortService só poderá mudar para outro tipo de serviço se o app estiver qualificado para iniciar um novo serviço em primeiro plano.
  • Um serviço em primeiro plano pode mudar o próprio tipo para shortService a qualquer momento, quando o tempo limite começa.

O tempo limite de shortService começa no momento em que Service.startForeground() é chamado. O app precisa chamar Service.stopSelf() ou Service.stopForeground() antes que o tempo limite seja atingido. Caso contrário, o novo Service.onTimeout() será chamado, dando aos apps a oportunidade de chamar stopSelf() ou stopForeground() para interromper o serviço.

Pouco depois que Service.onTimeout() é chamado, o app entra em um estado em cache e não é mais considerado em primeiro plano, a menos que o usuário esteja interagindo ativamente com ele. Se o app entra nesse estado e o serviço não é interrompido, o app recebe um erro ANR. A mensagem ANR menciona FOREGROUND_SERVICE_TYPE_SHORT_SERVICE. Por esses motivos, uma prática recomendada é implementar o callback Service.onTimeout().

O callback Service.onTimeout() não existe no Android 13 e nas versões anteriores. Se o mesmo serviço for executado nesses dispositivos, ele não receberá um tempo limite nem um erro ANR. Confira se o serviço é interrompido assim que a tarefa de processamento é terminada, mesmo que ele ainda não tenha recebido o callback Service.onTimeout().

É importante observar que, se o tempo limite do shortService não for respeitado, o app receberá um erro ANR mesmo que tenha outros serviços em primeiro plano válidos ou outros processos de ciclo de vida em execução.

Se um app estiver visível para o usuário ou atender a uma das isenções que permitem que serviços em primeiro plano sejam iniciados em segundo plano, chame Service.StartForeground() novamente com o parâmetro FOREGROUND_SERVICE_TYPE_SHORT_SERVICE, que estende o tempo limite em mais três minutos. Se o app não estiver visível para o usuário e não atender a uma das isenções, qualquer tentativa de iniciar outro serviço em primeiro plano, independente do tipo, vai causar uma ForegroundServiceStartNotAllowedException.

Se um usuário desativar a otimização da bateria para seu app, ele ainda será afetado pelo tempo limite do shortService FGS.

Se você iniciar um serviço em primeiro plano que inclua o tipo shortService e outro tipo de serviço em primeiro plano, o sistema vai ignorar a declaração do tipo shortService. No entanto, o serviço ainda precisará aderir aos pré-requisitos dos outros tipos declarados. Para mais informações, consulte a documentação de serviços em primeiro plano.

Uso especial

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
specialUse
Permissão para declarar no manifesto
FOREGROUND_SERVICE_SPECIAL_USE
Constante a ser transmitida para startForeground()
FOREGROUND_SERVICE_TYPE_SPECIAL_USE
Pré-requisitos do ambiente de execução
Nenhum
Descrição

Abrange todos os casos de uso de serviço em primeiro plano válidos que não são abrangidos por outros tipos de serviço em primeiro plano.

Além de declarar o tipo de serviço em primeiro plano FOREGROUND_SERVICE_TYPE_SPECIAL_USE, os desenvolvedores precisam declarar casos de uso no manifesto. Para fazer isso, especifique o elemento <property> no elemento <service>. Esses valores e os casos de uso correspondentes são analisados quando você envia o app no Google Play Console. Os casos de uso que você fornece são de formato livre, e é necessário fornecer informações suficientes para que o revisor entenda por que você precisa usar o tipo specialUse.

<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 para declarar no manifesto
FOREGROUND_SERVICE_SYSTEM_EXEMPTED
Constante a ser transmitida para startForeground()
FOREGROUND_SERVICE_TYPE_SYSTEM_EXEMPTED
Pré-requisitos do ambiente de execução
Nenhum
Descrição

Reservado para aplicativos do sistema e integrações específicas do sistema, para e continuar usando os 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

Caso o app seja destinado ao Android 14 ou versões mais recentes, declare os tipos de serviço em primeiro plano na página de conteúdo do app no Play Console (Política > Conteúdo do app). Para mais informações sobre como declarar os tipos de serviço em primeiro plano no Play Console, consulte Noções básicas sobre o serviço em primeiro plano e os requisitos de intent para tela cheia.