【Flutter×Amplify】Push通知機能実装 Android編

classpath 'com.google.gms:google-services:4.3.15'

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:32.1.0')

    // Add the dependencies for the Firebase Cloud Messaging and Analytics libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-messaging-ktx'
    implementation 'com.google.firebase:firebase-analytics-ktx'
}

amplify_push_notifications_pinpoint: ^1.0.0

flutter pub get

final authPlugin = AmplifyAuthCognito();
final pushPlugin = AmplifyPushNotificationsPinpoint();
await Amplify.addPlugins([authPlugin, pushPlugin]);
await Amplify.configure(amplifyconfig);

/*
  デバイストークンを取得してAWS Pinpointに登録する処理
  アプリ起動時に実行する
*/
Future<void> setupPushNotifications() async {
  try {
    final subscription =
        Amplify.Notifications.Push.onTokenReceived.listen((token) {
      safePrint("Device token: $token");

      // 必要に応じてサーバーサイドやデータベースにトークンを保存する処理を追加
    });

    // 不要になったときに購読をキャンセルする
    // 今回の例ではアプリがアクティブである間はキャンセルしていないが、必要に応じてキャンセルする。
    // subscription.cancel();
  } catch (e) {
    safePrint("Error Device token: $e");
  }
}

void main() async {
  runApp(MultiProvider(
    providers: [
      ChangeNotifierProvider(create: (context) => NavigationProvider()),
      ChangeNotifierProvider(create: (context) => UserProvider()),
    ],
    child: const MyApp(),
  ));
}

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

  @override
  MyAppState createState() => MyAppState();
}

class MyAppState extends State<MyApp> {
  // ユーザーのログイン状態を保持する変数を追加
  bool? _isUserSignedIn;

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

  _initializeApp() async {
    // Amplifyを初期化する
    await _configureAmplify();
    // Amplifyの初期化が完了した後にsetupPushNotificationsを呼び出す
    // デバイストークンを取得する
    await setupPushNotifications();
    // ログイン状態の確認を行う
    await _checkSignInStatus();
  }

  // ユーザーがログインしているかどうかを確認する関数
  Future<void> _checkSignInStatus() async {
    bool isSignedIn = await isUserSignedIn();
    setState(() {
      // ログイン状態を更新
      _isUserSignedIn = isSignedIn;
    });
  }

  // アプリケーションで Amplify を初期化する処理
  Future<void> _configureAmplify() async {
    // 利用するプラグインを追加する
    final authPlugin = AmplifyAuthCognito();
    final apiPlugin = AmplifyAPI(modelProvider: ModelProvider.instance);
    final pushPlugin = AmplifyPushNotificationsPinpoint();
    await Amplify.addPlugins([authPlugin, apiPlugin, pushPlugin]);

    // アプリ内で configure を呼び出す
    try {
      await Amplify.configure(amplifyconfig);
    } on AmplifyAlreadyConfiguredException {
      safePrint(
          "Tried to reconfigure Amplify; this can occur when your app restarts on Android.");
    }
  }

Device token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

import 'package:amplify_flutter/amplify_flutter.dart';

/*
  許可ステータスを取得する処理。ステータスは以下4種類
  
  1. PushNotificationPermissionStatus.shouldRequest
    権限はまだ要求されていない状態
  2. PushNotificationPermissionStatus.shouldExplainThenRequest
    権限をリクエストする前に、ユーザーに説明を表示する必要がある。
  3. PushNotificationPermissionStatus.granted
    権限はユーザーによって付与されている。それ以上のアクションは必要なく、アプリは通知を表示する準備ができている。
  4. PushNotificationPermissionStatus.denied
    権限はユーザーによって拒否されている。さらに権限を要求しようとしても、権限ダイアログは表示されなくなる。
    デバイス設定で必要な権限を付与するようユーザーに求める必要がある状態。
*/
Future<void> getPermissionStatus() async {
  final PushNotificationPermissionStatus status =
      await Amplify.Notifications.Push.getPermissionStatus();
  safePrint('push notification permission status: $status');
  handlePermissions(status);
}

/*
  許可ステータスに応じた対応 
*/
Future<void> handlePermissions(PushNotificationPermissionStatus status) async {
  switch (status) {
    case PushNotificationPermissionStatus.granted:
      // 権限はユーザーによって付与されているため、何もしなくていい
      break;
    case PushNotificationPermissionStatus.denied:
      // 権限はユーザーによって拒否されている。そもそも通知されない。
      break;
    case PushNotificationPermissionStatus.shouldRequest:
      /*
        ユーザーに権限をリクエストする
        sound: true に設定すると、通知に応じてサウンドを再生する機能を要求する。
        badge: true に設定すると、アプリのバッジを更新する機能を要求する。
      */
      await Amplify.Notifications.Push.requestPermissions(
        badge: true,
        sound: true,
      );
      break;
    case PushNotificationPermissionStatus.shouldExplainThenRequest:
      // 権限をリクエストする前にユーザーに説明する
      safePrint('TODO: 権限リクrスト前にユーザーに説明する必要がある。');
      // then request permissions
      await Amplify.Notifications.Push.requestPermissions();
  }
}