foreground_service_isolate 0.1.0

Spawn a long-running Flutter isolate in a foreground service

foreground_service_isolate

Helper to spawn a long-running isolate that supports Flutter plugins in an Android foreground service. Sets up isolate channel communication with isolate_channel.

Getting Started

android/app/src/main/AndroidManifest.xml:

<manifest>
    {YOUR PERMISSIONS HERE}

    <application>
        <service
            android:name="com.iodesignteam.foreground_service_isolate.IsolateForegroundService"
            android:exported="false"
            android:foregroundServiceType="{YOUR SERVICE TYPES HERE}" />
    </application>
</manifest>

See the foreground service types documentation for information on what types and permissions to declare based on your use case

Usage

import 'dart:isolate';

import 'package:flutter/foundation.dart';
import 'package:foreground_service_isolate/foreground_service_isolate.dart';
import 'package:permission_handler/permission_handler.dart';

const methodChannelId = 'foreground_service_isolate_method';

void example() async {
  // Notification permission is required to show a foreground service notification
  await Permission.notification.request();

  final connection = await spawnForegroundServiceIsolate(
    isolateEntryPoint,
    notificationDetails: const NotificationDetails(
      channelId: 'foreground_service_isolate',
      channelName: 'Foreground Service Isolate',
      id: 1,
      contentTitle: 'Foreground Service Isolate',
      contentText: 'Running...',
      // This resource must be present in android/app/src/main/res/drawable
      smallIcon: 'ic_launcher',
    ),
  );

  final methodChannel = IsolateMethodChannel(methodChannelId, connection);
  final result = await methodChannel.invokeMethod('ping');
  debugPrint(result);
}

@pragma('vm:entry-point')
void isolateEntryPoint(SendPort? send) {
  final connection = setupIsolate(send);

  final methodChannel = IsolateMethodChannel(methodChannelId, connection);
  methodChannel.setMethodCallHandler(
    (call) => switch (call.method) {
      'ping' => 'pong',
      _ => call.notImplemented(),
    },
  );
}

See the isolate_channel documentation for more information on how to use isolate connections