Flutter推送通知插件amplify_push_notifications_pinpoint的使用

插件介绍

amplify_push_notifications_pinpoint是Amplify Flutter Push Notifications类别的一个插件，它使用AWS Pinpoint作为提供者。该插件支持Android、iOS平台的通知推送功能。

平台支持情况

开始使用

要了解更多关于AWS Amplify的信息，请访问我们的官方网站。

示例代码

以下是一个完整的示例demo，演示如何在Flutter项目中集成和使用amplify_push_notifications_pinpoint插件。

主文件：main.dart

// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

// ignore_for_file: avoid_print

import 'package:amplify_auth_cognito/amplify_auth_cognito.dart';
import 'package:amplify_flutter/amplify_flutter.dart';
import 'package:amplify_push_notifications_pinpoint/amplify_push_notifications_pinpoint.dart';
import 'package:flutter/material.dart';

import 'amplifyconfiguration.dart';

Future<void> myCallback(PushNotificationMessage notification) async {
  print('🚀 onNotificationReceivedInBackground callback: $notification');
  await Future<void>.delayed(const Duration(seconds: 5));
  print(
    '  🚀 onNotificationReceivedInBackground callback: delayed for 5 seconds to complete',
  );
}

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  try {
    final authPlugin = AmplifyAuthCognito();
    final notificationsPlugin = AmplifyPushNotificationsPinpoint();

    // Needs to be given in the main function here so iOS can wire up the callback when the app wakes up from killed state
    notificationsPlugin.onNotificationReceivedInBackground(myCallback);

    if (!Amplify.isConfigured) {
      await Amplify.addPlugins([authPlugin, notificationsPlugin]);
      await Amplify.configure(amplifyconfig);
      // Required to call this after Amplify.configure.
      // Doesn't get called on app start as event is swallowed by library to register device.
      Amplify.Notifications.Push.onTokenReceived.listen((event) {
        print('🚀 onTokenReceived $event');
      });

      // Required to call this after Amplify.configure.
      Amplify.Notifications.Push.onNotificationReceivedInForeground
          .listen((event) {
        print('🚀 onNotificationReceivedInForeground $event');
      });

      // Required to call this after Amplify.configure.
      Amplify.Notifications.Push.onNotificationOpened.listen((event) {
        print('🚀 onNotificationOpened $event');
      });
    }
  } on Exception catch (e) {
    safePrint(e.toString());
  }
  AmplifyLogger().logLevel = LogLevel.info;
  runApp(const MyApp());
}

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

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  bool isConfigured = false;
  bool isForegroundListenerInitialized = false;
  bool isBackgroundListenerInitialized = false;
  bool notificationOpenedListenerInitialized = false;
  int globalBgCallbackCount = 0;

  PushNotificationMessage? foregroundMessage;
  PushNotificationMessage? backgroundMessage;

  PushNotificationMessage? notificationOpenedMessage;
  PushNotificationPermissionStatus? getPermissionStatus;
  bool? requestPermissionsResult;
  PushNotificationMessage? launchNotificationAvailable;

  void getLaunchNotification() {
    setState(() {
      launchNotificationAvailable =
          Amplify.Notifications.Push.launchNotification;
    });
  }

  Widget headerText(String title) => Padding(
        padding: const EdgeInsets.only(top: 16),
        child: Center(
          child: Text(
            title,
            style: const TextStyle(
              fontSize: 18,
              fontWeight: FontWeight.bold,
            ),
          ),
        ),
      );

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Amplify Push Notifications Pinpoint Example'),
        ),
        body: Center(
          child: ListView(
            children: [
              headerText('Permissions APIs'),
              ElevatedButton(
                onPressed: () async {
                  final status =
                      await Amplify.Notifications.Push.getPermissionStatus();
                  setState(() {
                    getPermissionStatus = status;
                  });
                },
                child: const Text('getPermissionStatus'),
              ),
              if (getPermissionStatus != null)
                Text('Permission status: $getPermissionStatus'),
              ElevatedButton(
                onPressed: () async {
                  final result =
                      await Amplify.Notifications.Push.requestPermissions();
                  setState(() {
                    requestPermissionsResult = result;
                  });
                },
                child: const Text('requestPermissions'),
              ),
              if (requestPermissionsResult != null)
                Text(
                  'Requesting permission result: $requestPermissionsResult',
                ),
              const Divider(
                height: 20,
              ),
              headerText('Analytics APIs'),
              ElevatedButton(
                onPressed: () async {
                  await Amplify.Notifications.Push.identifyUser(
                    userId: 'test-user-101',
                    userProfile: const UserProfile(name: 'test-name-101'),
                  );
                },
                child: const Text('identifyUser'),
              ),
              const Divider(
                height: 20,
              ),
              headerText('Notification Handling APIs'),
              ElevatedButton(
                onPressed: getLaunchNotification,
                child: const Text('get Launch Notification'),
              ),
              if (launchNotificationAvailable != null)
                ListTile(
                  title: Text(
                    'launchNotificationAvailable: $launchNotificationAvailable',
                  ),
                ),
            ],
          ),
        ),
      ),
    );
  }
}

配置文件：amplifyconfiguration.dart

确保你已经配置了Amplify，并且拥有正确的配置文件。以下是amplifyconfiguration.dart的一个示例：

import 'package:amplify_core/amplify_core.dart';

const amplifyconfig = '''{
  "UserAgent": "aws-amplify-cli/2.0",
  "Version": "1.0",
  "analytics_pinpoint": {
    "AWSPinpointAnalytics": {
      "appId": "YOUR_PINPOINT_APP_ID",
      "region": "YOUR_PINPOINT_REGION"
    }
  },
  "auth": {
    "plugins": {
      "awsCognitoAuthPlugin": {
        "UserAgent": "aws-amplify-cli/0.1.0",
        "Version": "0.1.0",
        "IdentityManager": {
          "Default": {}
        },
        "CredentialsProvider": {
          "CognitoIdentity": {
            "Default": {
              "PoolId": "YOUR_COGNITO_POOL_ID",
              "Region": "YOUR_COGNITO_REGION"
            }
          }
        },
        "CognitoUserPool": {
          "Default": {
            "PoolId": "YOUR_USER_POOL_ID",
            "AppClientId": "YOUR_APP_CLIENT_ID",
            "AppClientSecret": "YOUR_APP_CLIENT_SECRET",
            "Region": "YOUR_USER_POOL_REGION"
          }
        },
        "Auth": {
          "Default": {
            "authenticationFlowType": "USER_SRP_AUTH"
          }
        }
      }
    }
  }
}''';

请将上述代码中的占位符替换为你的实际AWS资源ID和区域信息。

通过以上步骤，你应该能够在Flutter应用中成功集成并使用amplify_push_notifications_pinpoint插件来处理推送通知。