firebase_messaging_handler 0.1.0

A comprehensive Flutter plugin for handling Firebase Cloud Messaging notifications with advanced features.

example/lib/main.dart

import 'dart:developer';

import 'package:firebase_core/firebase_core.dart';
import 'package:firebase_messaging_handler/firebase_messaging_handler.dart';
import 'package:flutter/material.dart';

import 'firebase_options.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await Firebase.initializeApp(
    options: DefaultFirebaseOptions.currentPlatform,
  );

  await FirebaseMessagingHandler.instance.checkInitial();
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      debugShowCheckedModeBanner: false,
      title: 'Firebase Messaging Handler Example',
      home: NotificationScreen(),
    );
  }
}

class NotificationScreen extends StatefulWidget {
  const NotificationScreen({super.key});

  @override
  State<NotificationScreen> createState() => _NotificationScreenState();
}

class _NotificationScreenState extends State<NotificationScreen> {
  late FirebaseMessagingHandler _messagingHandler;
  String? _currentPayload;
  bool _showClearButton = true;

  @override
  void initState() {
    _initFirebaseMessagingHandler();
    super.initState();
  }

  @override
  Future<void> dispose() async {
    await _disposeFirebaseMessagingHandler();

    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Handler Example'),
        centerTitle: true,
        actions: [
          InkWell(
            onTap: () async {
              await _disposeFirebaseMessagingHandler();
              await _messagingHandler.clearToken();
              await _initFirebaseMessagingHandler();
            },
            child: const Padding(
              padding: EdgeInsets.only(
                right: 20,
                left: 10,
              ),
              child: Icon(Icons.restart_alt),
            ),
          ),
        ],
      ),
      body: Center(
        child: Text(
          'Current Payload: \n$_currentPayload',
          textAlign: TextAlign.center,
        ),
      ),
      floatingActionButton: Row(
        mainAxisAlignment: MainAxisAlignment.center,
        children: [
          if (_showClearButton)
            Padding(
              padding: const EdgeInsets.only(right: 20),
              child: ElevatedButton(
                style: ElevatedButton.styleFrom(
                  backgroundColor: Colors.blue,
                ),
                child: const Text(
                  'Clear Token',
                  style: TextStyle(color: Colors.white),
                ),
                onPressed: () async {
                  //For testing logout behaviour where we clear the currently saved FCM Token from
                  //our Shared Preferences. So, that the update callback gets executed again. Whenever
                  //someone logs in again.

                  await _messagingHandler.clearToken();
                  setState(() {
                    _showClearButton = false;
                  });
                },
              ),
            ),
          ElevatedButton(
            style: ElevatedButton.styleFrom(
              backgroundColor: Colors.blue,
            ),
            child: const Text(
              'Clear Payload',
              style: TextStyle(color: Colors.white),
            ),
            onPressed: () {
              setState(() {
                _currentPayload = null;
              });
            },
          ),
        ],
      ),
      floatingActionButtonLocation: FloatingActionButtonLocation.centerFloat,
    );
  }

  Future<void> _initFirebaseMessagingHandler() async {
    _messagingHandler = FirebaseMessagingHandler.instance;
    Stream<NotificationData?>? clickStream = await _messagingHandler.init(
      androidChannelList: [
        NotificationChannelData(
          id: 'android_notification_channel_id',
          name: 'name can be anything',
          importance: NotificationImportanceEnum.max,
          priority: NotificationPriorityEnum.high,
        ),
      ],
      ///When ever you are referencing an android asset here please
      ///make sure you set is as default in AndroidManifest or else it may be removed
      ///via Proguard while running a release build.
      androidNotificationIconPath: '@drawable/ic_notification',
      ///Sender id is always same for both Android and iOS
      senderId: DefaultFirebaseOptions.android.messagingSenderId,
      updateTokenCallback: (final String fcmToken) async {
        log('FCM Token: $fcmToken');
        setState(() {
          _showClearButton = true;
        });
        //Use print for release mode FCM Debugging
        print('FCM Token: $fcmToken');

        //Returning true lets the utility know that the token has been saved by the backend.
        //And so this function should not be called till the token has been cleared with the removeToken()
        //Note: Re-installing or clearing data will also recall this function.
        return Future.value(true);
      },
    );

    if (clickStream != null) {
      clickStream.listen((NotificationData? data) {
        if (data != null) {
          setState(() {
            _currentPayload =
                (data.payload.isNotEmpty ? data.payload : '').toString();
          });
        }
      });
    }
  }

  Future<void> _disposeFirebaseMessagingHandler() async {
    _messagingHandler.clearToken();
    _messagingHandler.dispose();
  }
}