パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v1.5.0

geofence_foreground_service

位置情報のジオフェンシングを処理するためのフォアグラウンドサービスを作成するFlutterプロジェクト。

AndroidiOS
30日間ダウンロード
384
いいね数
38
Pub ポイント
160

パッケージをインストール

flutter pub add geofence_foreground_service

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

Android および iOS でフォアグラウンドサービスを実行することで、ジオフェンシングを可能にする Flutter パッケージです。アプリが地理的境界を監視し、ユーザーが定義された領域に入ったり出たりしたときにアクションをトリガーできるようにします。アプリがバックグラウンドにある場合でも動作します。継続的に実行され、永続的な通知を表示するため、プラットフォーム固有の制約においても信頼性が確保されます。リアルタイムでの位置追跡に最適で、最小限のセットアップで Android と iOS の両方をサポートしています。

用途

  • リアルタイム位置モニタリング
  • 小売または物流向けのジオフェンシングアラート
  • フィットネスアプリにおける位置ベースのトリガー
  • 配送サービスのバックグラウンドトラッキング
  • 距離に基づく通知

主な機能

  • 永続的なフォアグラウンドサービス
  • クロスプラットフォームの Android および iOS サポート
  • 最小限の構成が必要
  • Flutter の位置情報サービスとの統合
  • 入退場ジオフェンスイベントをサポートします

適している対象

  • バックグラウンドでの位置情報追跡を必要とするアプリ
  • 位置認識アプリケーション
  • 信頼性のあるジオフェンシングを必要とするサービス
  • 物流または小売ソリューションを開発する開発者
  • 厳格なバックグラウンド実行要件を備えたプロジェクト

注意事項

  • 場所のアクセスにユーザーの許可が必要です
  • 恒久的な通知はUXに影響を与える可能性があります
  • 継続的なトラッキングに伴い、バッテリーの消費が増加します
  • プラットフォーム固有のバックグラウンド実行制限
  • iOSのバックグラウンドモード用に追加の構成が必要になる場合があります

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

geofence_foreground_service

Flutter Version License Platform Platform

A Flutter plugin that enables you to easily handle geofencing events in your Flutter app by utilizing native OS APIs on Android by creating a foreground service while being battery efficient since it uses the Geofence and WorkManager APIs. And on iOS by utilizing the CLLocationManager

It's important to note that the workmanager and flutter_foreground_task plugins were a great source of inspiration while creating this plugin.

Android iOS
Android Demo iOS Demo

Features

  • Supports geofencing in foreground as well as background 💪
  • Geofence a circular area 🗺️
  • Geofence a polygon 🤯 You can add a geofence using a list of coordinates, the system will calculate the center of them and register it, having full polygon support is a WIP 🚧
  • Notification customization 🔔: ⚠️Android⚠️ Displaying a notification when running a foreground service is mandatory, you can customize what is being displayed on it (title, content or the icon), the plugin displays your app icon by default.
  • Notification responsiveness ⏱️: ⚠️Android⚠️ You can set the responsiveness of the android notifications as per the docs here

Setup

🔧 Android Setup
  • Enable MultiDex, you can check how to do so here
  • Add the service to the AndroidManifest.xml inside the application tag
<service 
    android:name="com.f2fk.geofence_foreground_service.GeofenceForegroundService"
    android:foregroundServiceType="location">
</service>
  • Add the permissions
<!--required-->
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_LOCATION" />

<!--at least one of the follwoing-->
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
  • Make sure the minSdkVersion in the app/build.gradle file is 29+
🔧 iOS Setup
  • Navigate to the Podfile and make sure to set the iOS version to 12+
platform :ios, '12.0'
  • Make sure to add the following permission to your Info.plist
<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
<string>This app need your location to provide best feature based on location</string>
<key>NSLocationAlwaysUsageDescription</key>
<string>This app need your location to provide best feature based on location</string>
<key>NSLocationWhenInUseUsageDescription</key>
<string>This app need your location to provide best feature based on location</string>
  • Turn on the Location updates and Background fetch capabilities from XCode iOS capabilities

Example

Define the method that will handle the Geofence triggers

import 'package:geofence_foreground_service/exports.dart';
import 'package:geofence_foreground_service/geofence_foreground_service.dart';
import 'package:geofence_foreground_service/models/zone.dart';

// This method is a top level method
@pragma('vm:entry-point')
void callbackDispatcher() async {
  GeofenceForegroundService().handleTrigger(
    backgroundTriggerHandler: (zoneID, triggerType) {
      log(zoneID, name: 'zoneID');

      if (triggerType == GeofenceEventType.enter) {
        log('enter', name: 'triggerType');
      } else if (triggerType == GeofenceEventType.exit) {
        log('exit', name: 'triggerType');
      } else if (triggerType == GeofenceEventType.dwell) {
        log('dwell', name: 'triggerType');
      } else {
        log('unknown', name: 'triggerType');
      }

      return Future.value(true);
    },
  );
}

Then create an instance of the plugin to initiate it and assign GeoFences to it

final List<LatLng> timesSquarePolygon = [
  const LatLng(40.758078, -73.985640),
  const LatLng(40.757983, -73.985417),
  const LatLng(40.757881, -73.985493),
  const LatLng(40.757956, -73.985688),
];

Future<void> initPlatformState() async {
  // Remember to handle permissions before initiating the plugin

  bool hasServiceStarted = await GeofenceForegroundService().startGeofencingService(
    contentTitle: 'Test app is running in the background',
    contentText: 'Test app will be running to ensure seamless integration with ops team',
    notificationChannelId: 'com.app.geofencing_notifications_channel',
    serviceId: 525600,
    callbackDispatcher: callbackDispatcher,
  );

  if (hasServiceStarted) {
    await GeofenceForegroundService().addGeofenceZone(
      zone: Zone(
        id: 'zone#1_id',
        radius: 10000, // measured in meters
        coordinates: timesSquarePolygon,
        triggers: [
          GeofenceEventType.dwell,
          GeofenceEventType.enter,
          GeofenceEventType.exit
        ], // Currently, only available on Android
        expirationDuration: const Duration(days: 1), // Currently, only available on Android
        dwellLoiteringDelay: const Duration(hours: 1), // Currently, only available on Android
        initialTrigger: GeofenceEventType.enter, // Currently, only available on Android
      ),
    );
  }
}

Something important to point out is the callbackDispatcher method will run in an entirely different isolate than the actual app, so if you were to handle UI related code inside of it you'll need to use Ports, you can find more information here

You can pass a custom icon to the foreground service notification if you wish while initializing the service, this icon will be placed inside the android/app/src/main/res folder, you can check the example for more information, by default, it will take the app icon

const NotificationIconData(
  resType: ResourceType.mipmap,
  resPrefix: ResourcePrefix.ic,
  name: 'launcher',
)

Notes

Handling permissions is not a part of the package, so please refer to permission_handler plugin to grant the required permissions (it's used in the example too)

  • location
  • locationAlways
  • notification

Contributing

We welcome contributions. Please read CONTRIBUTING.md for pull request expectations (including small PRs and a maximum of 15 files per PR), testing, changelog updates, and review practices.

カテゴリー

依存関係

依存関係一覧 2 件

  • latlng^2.0.7
  • plugin_platform_interface^2.1.8

ソースリポジトリ

このパッケージを使用しているプロジェクト

データはまだありません。