SampleForegroundService - GitLite

KO | EN

gitlite — search

#nodejs #database #golang #dotnet #api #hacktoberfest #devops #privacy #proxy #csharp

SampleForegroundService

(★ 12)

This sample project demonstrates the setup for a foreground service. The service in this project is a foreground service used to request location. The required permissions depend on the type of foreground service.

File Explorer

ZIP Download

- - Project_Default.xml
- .gitignore
- AndroidProjectSystem.xml
- appInsightsSettings.xml
- compiler.xml
- deploymentTargetDropDown.xml
- deploymentTargetSelector.xml
- deviceManager.xml
- gradle.xml
- kotlinc.xml
- markdown.xml
- migrations.xml
- misc.xml
- runConfigurations.xml
- vcs.xml
- .gitignore
- build.gradle.kts
- proguard-rules.pro
- - gradle-wrapper.jar
  - gradle-wrapper.properties
.gitignore
build.gradle.kts
gradle.properties
gradlew
gradlew.bat
LICENSE
README.md
settings.gradle.kts

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

# Project Badges

Linktree Visit
Site Visit
X Visit
LinkedIn Visit
Medium Visit
Mastodon Visit
Bluesky Visit
Dev.to blog Visit
YouTube Visit
Google Developer Profile Visit

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

This sample project demonstrates the setup and implementation of a foreground service in Android. It specifically showcases how to handle location updates and manage service persistence.

> [!IMPORTANT]  
> Check out the full guide here:  
> 👉 **[Foreground Service in Android - Medium](https://medium.com/@nicosnicolaou/foreground-service-in-android-9ff18be69ef6)** 👈

> [!IMPORTANT]
> Similar project with (Dart Language) :point_right: [SampleForegroundServiceFlutter](https://github.com/NicosNicolaou16/SampleForegroundServiceFlutter) :point_left: <br />

## ✨ Features

*   **Location Tracking:** Demonstrates background/foreground location updates.
*   **Android 14+ Ready:** Properly declares `foregroundServiceType` as required by the latest SDKs.
*   **Persistent Service:** Includes a Broadcast Receiver to restart the service after device reboots.
*   **Permission Management:** Shows the specific setup for `FOREGROUND_SERVICE_LOCATION`.

## 🛠️ Setup

### Manifest Configuration

To use a foreground service for location, you must declare the appropriate permissions and the service type in your `AndroidManifest.xml`:

```xml

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">

<uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />

<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_LOCATION" />

<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />

<application>

<service android:name=".service.LocationService" android:enabled="true"
            android:exported="false" android:foregroundServiceType="location" />

<receiver android:name=".broadcast_receiver.RestartServiceBroadcastReceiver"
            android:enabled="true" android:exported="false">
            <intent-filter>
                <action android:name="android.intent.action.BOOT_COMPLETED" />
            </intent-filter>
        </receiver>

</application>
</manifest>
```

## 🔧 Versioning

- **Target SDK:** **37**
- **Minimum SDK:** **29**
- **Kotlin Version:** **2.4.0**
- **Gradle Version:** **9.2.1**

## 📚 References

- **Android Developers:** [Foreground service types are required](https://developer.android.com/about/versions/14/changes/fgs-types-required)
- **Stack Overflow:** [Auto-run service after reboot](https://stackoverflow.com/questions/14385231/android-broadcastreceiver-auto-run-service-after-reboot-of-device)

## ⭐ Stargazers

If you find this project useful, please give it a star!  
[View Stargazers on GitHub](https://github.com/NicosNicolaou16/SampleForegroundService/stargazers)

## 🙏 Support & Contributions

This project is actively maintained. Feedback, bug reports, and feature requests are welcome! Please feel free to **open an issue** or submit a **pull request**.